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.
- Installation
- Usage
- License
- Questions
- Contributing
- Tests
- Screenshots
- Links
- Credits
- Technology
- Future Development
TODO: Describe the installation process
- Clone the repo
- Run
bundle install
to install dependencies - Configure the file
config/database.yml
to match your database settings - Run
rails db:create
to create the database - Run
rails db:migrate
to create the tables
TODO: Write usage instructions
- Run
rails s
to start the server - Open your browser and go to
localhost:3000
to view the application - Use an application such as Postman to test the 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
This project is licensed under the MIT License - see the LICENSE.md file for details
If you have any questions, please contact me at the email below. Check out my Github portfolio for more of my projects!
- Github username: nicholastn1
TODO: Write contribution instructions
TODO: Write test instructions
TODO: Add screenshots
TODO: Add links
TODO: Write credits
TODO: Write future development