Skip to content

DcRonan/apex-api

Repository files navigation

APEX API

Click here for frontend app

Microverse

Library Directory 📙

Contents
Built With
Live Demo
Install
Testing
Authors
License

Description

I have built a Rails API that handles data and authentication to let you track your sports & fitness workouts using a React app that I built.

Routes

Action What It Does HTTP Verb URL
index Return a list of current sports. GET /sports
create Create a new sport. POST /sports
show Return a single sport. GET /sports/:id
create Create a new user. POST /users
session Create a new session. POST /login

ERD

ERD

Built With 🛠

- Ruby on Rails
- Ruby
- PostgreSQL
- Heroku
- VS Code

Ruby on Rails Ruby PostgreSQL Ruby Gems Heroku VS Code

Install ⏳

Follow these steps below to get my Application working.

    • Open your Terminal
    • Navigate to the directory where you will like to install the repo by running cd apex-api
    • Run git clone [email protected]:DcRonan/apex-api.git to download or you can download using HTTPS by running git clone https://github.com/DcRonan/apex-api.git in the terminal
    • Run cd apex-api to enter the directory
    • Run bundle install to install Ruby Gems (hint: Mac users, if not working then run sudo bundle install)
    • Run rails db:create to create a local database
    • Run rails db:migrate to migrate the database
    • Run rails s to start up the server
    • Open https://localhost:3000/ in your browser

Testing ⚙

I have used linters to test my code, which includes: rspec

    • Open Terminal again
    • Run cd apex-api to enter the directory
    • Run rspec to start testing
    • All tests will pass ✅

Authors

👨‍💻 Daniel Ronan

GitHub
LINKEDIN
EMAIL
TWITTER

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

License

Cocoapods

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published