Final Capstone Project - Appointments App

This is the final Microverse's capstone project!! The purpose of the project is to create a Full-Stack app that works with a backend in Rails and a Frontend in React. This repo contains the backend project. It's a Rails API that is able to receive connections to:

• Create and authenticate users
• Get a list of available tutors
• Make an appointment with a tutor
• Show the list of the user's appointments

Built With

• Ruby on Rails

Live Demo

You can find the complete and functional app here: Live Demo Link

Setup

• To get a local copy up and running follow these simple example steps.
  • Clone the repo and cd in it.
  • Run bundle install to get all gems installed on your directory
  • Run rails db:create and then rails db:migrate to set the Database
  • Run rails s to open the server
  • You can go to the frontend repo here and follow instructions there. Or you can connect your own frontend (by requesting access first)

Usage

Login

• Post: https://appointments-api-majovanilla.herokuapp.com/auth/login
• Parameters: { name: string, email; string }

SignUp

• Post: https://appointments-api-majovanilla.herokuapp.com/signup
• Parameters: { name: string, email: string, password: string }

Tutors

• Get: https://appointments-api-majovanilla.herokuapp.com/tutors
• Headers: { Authorization: 'Bearer ${token}'

Tutor

• Get: https://appointments-api-majovanilla.herokuapp.com/tutors/${id}
• Headers: { Authorization: 'Bearer ${token}'

Appointment

• Post: https://appointments-api-majovanilla.herokuapp.com/appointment/new
• Parameters: { location: string, date: date, tutor_id: integer, }
• Headers: { Authorization: 'Bearer ${token}'

Appointments

• Get: https://appointments-api-majovanilla.herokuapp.com/appointments
• Headers: { Authorization: 'Bearer ${token}'

Testing

• To check tests you need to comment line 7 and uncomment line 8 of app/lib/json_web_token.rb This should also be done if you want to test the app in dev env, otherwise, it won't work.
• Run rspec in your terminal (check that you are in the repo's folder) to run all the testing suite.

Author

👤 majovanilla

• Github: @githubhandle
• Twitter: @twitterhandle
• Linkedin: linkedin

🤝 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!

Acknowledgments

• This project is part of the React Microverse Curriculum

📝 License

This project is MIT licensed.