/moveit

Move.it is a project created by Rocketseat bol to be a platform that combines the pomodoro technique, which consists of alternating cycles of focus and rest, with well-being exercises for those who spend many hours in front of a computer, who can be harmful to your health when you don't exercise or rest!

Primary LanguageTypeScript

Move.it Logo

Move.it is a project created by Rocketseat initially to be a platform that combines the technique of pomodoro, which consists of alternating cycles of focus and rest, with exercises for well-being for those who spend many hours in front of a computer, which can be harmful to health when you do no exercise or take periods of rest!

Made by Carlos Miguel Carlos Miguel Repository size
GitHub last commit License
Stargazers

Move.it Logo

Table of Contents

🚀 Getting Started

Prerequisites

  • To run any ReactJS application you need to configure the environment on your machine.

  • Setting the environment is a simple process, so it's recommended to follow the Rocketseat guide which is currently the most complete and detailed to make the settings:

Rocketseat Guide

Clone

  • Clone this repo to your local machine using:
https://github.com/solrachix/moveit

Setup

  • Install project dependencies;

    • yarn install
// or
npm install

  • Run project in development mode;

    • yarn dev
// or
npm run dev

  • Be Happy! 😆

⚔ Challenges

  • Create Documentation
    • GIF
    • Example Video
    • Awesome Readme
    • Techs used
    • Project Setup
    • Features
    • Pages Prints
  • Improve Styles
    • Few adjustments to make the style equal to the layout
    • Add Media queries
    • Create Theme Switcher
    • Create Dark Theme
  • Add PWA Feature
  • move.it 2.0
    • Few adjustments to make the style equal to the layout
    • SignIn Page
    • Github login
    • Sidebar Menu
    • Leaderboard
    • Twitter Sharing Button
    • Generate Twitter thumb to share

📋 Features

Documentation

  • WIP ...

Build with

  • ReactJS - A JavaScript library for building user interfaces
  • Typescript - TypeScript is an open-source language which builds on JavaScript, one of the world’s most used tools, by adding static type definitions.
  • Next.JS - Next.js gives you the best developer experience with all the features you need for production: hybrid static & server rendering, TypeScript support, smart bundling, route pre-fetching, and more. No config needed.

🤔 Contributing

To get started...

Step 1

  • 🍴 Fork this repo!

Step 2

  • 👯 Clone this repo to your local machine using https://github.com/solrachix/moveit

Step 3

  • 🎋 Create your feature branch using git checkout -b my-feature

Step 4

  • ✅ Commit your changes using git commit -m 'feat: My new feature';

Step 5

  • 📌 Push to the branch using git push origin my-feature;

Step 6

  • 🔃 Create a new pull request

After your Pull Request is merged, can you delete your feature branch.

📌 Support

Reach out to me at one of the following places!

📝 License

License

This project is licensed under the MIT License - see the LICENSE file for details.

Made by Carlos Miguel with 💙 Enjoy it!