Contents |
---|
Built With |
Live Demo |
Install |
Testing |
Authors |
License |
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.
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 |
- Ruby on Rails
- Ruby
- PostgreSQL
- Heroku
- VS Code
Follow these steps below to get my Application working.
-
- Open your
Terminal
- Open your
-
- Navigate to the directory where you will like to install the repo by running
cd apex-api
- Navigate to the directory where you will like to install the repo by running
-
- Run
git clone [email protected]:DcRonan/apex-api.git
to download or you can download usingHTTPS
by runninggit clone https://github.com/DcRonan/apex-api.git
in the terminal
- Run
-
- Run
cd apex-api
to enter the directory
- Run
-
- Run
bundle install
to install Ruby Gems (hint: Mac users, if not working then runsudo bundle install
)
- Run
-
- Run
rails db:create
to create a local database
- Run
-
- Run
rails db:migrate
to migrate the database
- Run
-
- Run
rails s
to start up the server
- Run
-
- Open
https://localhost:3000/
in your browser
- Open
I have used linters to test my code, which includes: rspec
-
- Open
Terminal
again
- Open
-
- Run
cd apex-api
to enter the directory
- Run
-
- Run
rspec
to start testing
- Run
-
- All tests will pass ✅
Contributions, issues and feature requests are welcome!
Feel free to check the issues page.
Give a ⭐️ if you like this project!