![Logo](/kaiorosa1/exercise-tracker-api/raw/main/images/logo.png)
A project based on the exercise tracker from FCC
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
This is a simple CRUD project for users to log their exercises.
To get a local copy up and running follow these simple example steps.
If you want to run this project locally you need to have Node.js (At least 14.x) installed in your machine.
- npm
npm install npm@latest -g
- Clone the repo
git clone https://github.com/kaiorosa1/exercise-tracker-api.git
- Install NPM packages
yarn install
- Run the project
yarn dev
In this project you will be able to create a user and then log their exercises
To create a user you send a POST to /users with the following payload as an example:
{
"name": "John Smith",
"email": "johnsmith@email.com",
"password": "senhanaosalvaassim"
}
For more examples, please refer to the Documentation
- Create Users
- Create Categories
- Create Exercises
See the open issues for a full list of proposed features (and known issues).
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt
for more information.
Kaio Rosa - @Kaio_Rosa - kaiosrosa@gmail.com
Project Link: https://github.com/kaiorosa1/exercise-tracker-api