wilsonfsouza / focus-tracker-next

Smart.it is a web application that combines a gamified experience of the pomodoro technique with healthy exercises between short breaks of work/study sessions.

Table of contents

About • Features • Layout • How to run • Technologies • Author • License

💻 About the project

Smart.it is a web application that combines a gamified experience of the pomodoro technique with healthy exercises between short breaks of work/study sessions. Keep up with your productivity without sacrificing your health. Smart.it is the dream application of chiropractors and eye doctors for their patients.

---

🔥 Preview

---

⚙️ Features

• Authentication using GitHub (Next-Auth).

• Users can level up by completing challenges.

• Challenges are available after a 25-minute work/study session.

• Users can use application on desktop, tablet, and mobile devices.

---

🎨 Layout

---

🚀 How to run the project

Requirements

Initial requirements: git, yarn, and a code editor of your choice.

Running the web application (Frontend)

# Clone this repository
$ git clone [email protected]:wilsonfsouza/focus-tracker-next.git

# Access the folder in your terminal/cmd/cli
$ cd focus-tracker-next

# Install all dependencies
$ yarn install

# Start the app in development mode
$ yarn dev

# The application will open at port:3000 - access http://localhost:3000

Running tests

# Run tests
$ yarn test

# Generate coverage report
$ yarn test --coverage

# Clean tests cache
$ yarn test --clearCache

---

🛠 Technologies

The following tools were used in this project:

Website (NextJS + TypeScript)

• ReactJS
• Next-Auth
• Axios
• Fauna DB
• React Icons
• Styled-components
• Jest
• ESLint
• Prettier
• EditorConfig

See the file package.json

Utilities

• Editor: Visual Studio Code
• Markdown: Markdown Emoji
• Icons: Feather Icons

---

💪 How to contribute to this project

1. Fork the project.
2. Start a new branch with your changes: git checkout -b my-new-feature
3. Save it and create a commit message describing what you have done: git commit -m "feature: My new feature"
4. Send your alterations: git push origin my-feature

---

👨‍💻 Author

_{Wilson Franca}

---

📝 License

This project is being developed under MIT License.

Made with ❤️ by Wilson Franca 👋