Skip to content

Commit

Permalink
docs: transferred project images to docs and updated README. Moved co…
Browse files Browse the repository at this point in the history
…ding standards, version control practices, and branching/merging strategy into docs for easier access.
  • Loading branch information
Dedakup committed Nov 26, 2024
1 parent 1c8691b commit 3461e76
Show file tree
Hide file tree
Showing 24 changed files with 15,122 additions and 1,690 deletions.
33 changes: 17 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# FocusFlow: Pomodoro & To-Do List Application

https://focusflow-zeta.vercel.app/

<img src="./public/FocusFlow-banner.png" alt="Banner" style="width:100%;"/>
<img src="./docs/images/FocusFlow-banner.png" alt="Banner" style="width:100%;"/>
<p align="center">
<img src="./public/mobile-preview.jpg" alt="Phone Preview" style="height:350px; margin-right: 10px;""/>
<img src="./public/desktop-preview.jpg" alt="Desktop Preview" style="height:350px;"/>
</p>


## Overview

**FocusFlow** is a productivity application developed using React and Tailwind CSS during a pair programming session with my college. The application combines a **Pomodoro timer** and a **To-Do list** to help users manage their time efficiently and keep track of their tasks.
Expand All @@ -19,16 +19,19 @@ Check out the live demo of the application [here](https://focusflow-zeta.vercel.
### Features

#### To-Do List:

- Add, edit, and delete tasks.
- Mark tasks as completed.
- Filter tasks by status (All, Completed, Incomplete).

#### Pomodoro Timer:

- Simple and intuitive Pomodoro timer.
- Customizable session and break lengths.
- Visual and audio cues to start and stop sessions.

#### Beautiful Design:

- Modern and clean user interface.
- Cozy and calming background theme to enhance focus.
- **Lo-Fi Music**: Built-in lo-fi music player to create a soothing environment for productivity.
Expand All @@ -47,26 +50,23 @@ Follow these steps to set up the project on your local machine.

1. **Clone the Repository**:

```bash
git clone https://github.com/dedakup/focusflow.git
cd focusflow
```

```bash
git clone https://github.com/dedakup/focusflow.git
cd focusflow
```
2. **Install Dependencies**:

```bash
npm install
```

```bash
npm install
```
3. **Start the Development Server**:

```bash
npm run dev
```

```bash
npm run dev
```
4. **Open the Application**:

Visit `http://localhost:5173` in your browser to view the application.
Visit `http://localhost:5173` in your browser to view the application.

## Usage

Expand All @@ -86,6 +86,7 @@ Follow these steps to set up the project on your local machine.
We welcome contributions! If you'd like to contribute to the project, please fork the repository and use a feature branch. Pull requests are warmly welcome.

# Branch Naming Conventions

- `main`: Production-ready code.
- `develop`: Latest integrated development work.
- `feature/<feature-name>`: For new features.
Expand Down
Loading

0 comments on commit 3461e76

Please sign in to comment.