Skip to content

nicholastn1/gymgeniusapi

Repository files navigation

GymGenius

Description

GymGenius is an Rails API that allows users to create and track daily workouts. Users can log multiple exercises in a workout on a given day. Users can also track the name, type, weight, sets, reps, and duration of exercise. If the exercise is a cardio exercise, users can track their distance traveled.

Table of Contents

Installation

TODO: Describe the installation process

  1. Clone the repo
  2. Run bundle install to install dependencies
  3. Configure the file config/database.yml to match your database settings
  4. Run rails db:create to create the database
  5. Run rails db:migrate to create the tables

Usage

TODO: Write usage instructions

  1. Run rails s to start the server
  2. Open your browser and go to localhost:3000 to view the application
  3. Use an application such as Postman to test the API endpoints

API Endpoints

  • POST /signup - Create a new user
  • POST /login - Login a user
  • DELETE /logout - Logout a user
  • GET /current_user - Get the current user
  • GET /signup/edit - Edit the current user TODO: Add more endpoints

License

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

Questions

If you have any questions, please contact me at the email below. Check out my Github portfolio for more of my projects!

Contributing

TODO: Write contribution instructions

Tests

TODO: Write test instructions

Screenshots

TODO: Add screenshots

Links

TODO: Add links

Credits

TODO: Write credits

Technology

Future Development

TODO: Write future development

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages