Move.it

A Gamified Pomodoro Website.

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. License
5. Contact

About The Project

This project is still under development.

Built With

This project is built with the following technologies:

• React JS
• TypeScript
• Firebase
• Next JS

Getting Started

To get a local copy of this project up and running follow these simple example steps:

Prerequisites

To get this project up and running, you must have these installed:

• Node JS
• Git
• A Package manager, npm (built in node) or yarn

Installation

1. Create a project in Firebase in test mode.
2. Add a Web APP to your firebase project
3. Clone the repo

   git clone https://github.com/miguelsndc/Move.it.git

4. Create a .env.local file and populate it with the firebase configs of your web app.
5. Install NPM packages

   npm install // yarn 

6. Start the project

   npm dev // yarn dev

Contributing

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

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

License

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

Contact

Miguel Nogueira - Linkedin - mglsndc@gmail.com

This project is still under development