Exercise Tracker API

A project based on the exercise tracker from FCC
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This is a simple CRUD project for users to log their exercises.

Built With

• 

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

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

Installation

1. Clone the repo

   git clone https://github.com/kaiorosa1/exercise-tracker-api.git

2. Install NPM packages

   yarn install

3. Run the project

   yarn dev

(back to top)

Usage

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

(back to top)

Roadmap

• Create Users
• Create Categories
• Create Exercises

See the open issues for a full list of proposed features (and known issues).

(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)

Contact

Kaio Rosa - @Kaio_Rosa - kaiosrosa@gmail.com

Project Link: https://github.com/kaiorosa1/exercise-tracker-api

(back to top)