Hamziss/timerr

timerr is an open source productivity web app. The goal of this app is to help you to be productive and focus on any task you are working on it can be anything , for example studying, writing, or coding.

Timerr

A Pomodoro timer App for Productivity !
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation

About The Project

timerr is a free productivity web app. The goal of this app is to help you to be productive and focus on any task you are working on it can be anything , for example studying, writing, or coding. 😄.

(back to top)

Tech Stack used

• React.js
• Typescript
• NextJS
• MongoDB
• zustand
• next-auth

(back to top)

Getting Started

To get a local copy up you have to first create a cluster in redis cloud .

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/Hamziss/timerr.git

2. Install NPM packages

   cd timerr
   npm install

3. Enter this env variables in .env

    MONGODB_URI=""
    NEXTAUTH_SECRET=""
    NEXTAUTH_URL="http://localhost:3000"
    NEXT_PUBLIC_SECRET_SESSION=""
    NEXT_PUBLIC_CLOUDINARY_URL="your cloundinary link"
    ANALYZE="false"
    GOOGLE_CLIENT_ID=
    GOOGLE_CLIENT_SECRET=
    GITHUB_ID=
    GITHUB_SECRET=

4. start the server by :

   npm run dev
   

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)