This project is created as a challenge for a job offer.
- This service lets clients book appointments with providers
- The service requires you signup with a username and password for security
- After singning-in, you get a JWT token, which you must include in every request, if not, the service considers the request invalid.
- The JWT token is valid for an hour
- Every user has a role: Admin, Client or Provider. By default, the Client role is provided if none specified (view the endpoints details further below)
- All requests are responded with JSON objects.
- UI for admin staff
- Variety of reports
- Recover password
- Booking appointments for a range of days (as of now, users can only book appointments for one day)
Refer to the endpoints section where you will get the base URL for testing the API. The backend is hosted on Heroku.
- You can find the repo here.
- Ruby 2.7.2
- Rails 6.1.4.1
- Ruby 3.0.
- Rails 6.1.3
- Postgres: >=9.5
- Node.js
- Yarn
- Open your terminal - Windows:
Win + R
, then typecmd
| Mac:Command + space
, then typeTerminal
- Navigate to a directory of your choosing using the
cd
command - Run this command in your OS terminal:
git clone [email protected]:MiguelArgentina/ror-appointments-api.git
to get a copy of the project. - Navigate to the project's directory using the
cd
command - Install gems with:
bundle install
- Setup database with:
rails db:create
rails db:migrate
- Fill in the database with test data using:
rails db:seed
- Start server with:
rails server
- Open
http://localhost:3000/
in your browser to see server interaction with user requests. - You can use
curl
commands for sending requests or Postman. Remember to add the authorization token received after sing-in for every request you make. Refer to endpoints section to get a list of all available options
👤 Miguel Ricardo Gomez
- GitHub: @MiguelArgentina
- Twitter: @Qete_arg
- LinkedIn: Miguel Ricardo Gomez
Give a ⭐️ if you like this project!
- Thanks to GreekDataGuy for his excellent Devise-JWT Tutorial.
Available as open source under the terms of the MIT License.