Skip to content

Latest commit

 

History

History
111 lines (76 loc) · 3.69 KB

README.md

File metadata and controls

111 lines (76 loc) · 3.69 KB
Raw

Ankle Arrival Back-end API

Version Documentation Maintenance License: MIT Twitter: vokeugo


Ankle Arrival - Connects sports athletes to physiotherapists and provides an instant diagnosis to sports-related injuries using Artificial Intelligence.

Ankle Arrival runs on a RESTful back-end API that support basic functionalities such as:

  • Users can signup / signin
  • Users can view a list of doctors
  • Users can book appointment with a doctor
  • Users can take Free Checkup using the instant diagnosis AI

Ankle Arrival API is hosted on Heroku and can be tested using Postman or Swagger UI or any other REST client tool.

Live URL: https://anklearrival.herokuapp.com

API Docs: https://anklearrival.herokuapp.com/api-docs/index.html

ankle-arrival

Future implementations:

  • Add support for Doctors (Physiotherapists) to SignUp and add thier schedules or confirm appointments
  • Use Calendly API for easy scheduling of appointments
  • Add support to cancel appointments

Built with:

  • Ruby 2.4.0
  • Rails 5.2
  • PostgreSQL
  • JWT
  • Heroku
  • RSwag
  • RSpec

Installation

Clone this repository from your terminal

git clone https://github.com/johnsonsirv/ankle-arrival-backend.git

Database setup

in your terminal run

rake db:setup

rake db:migrate db:test:prepare

Run test suite
run integration level tests (request tests spec/requests/api/v1/ using swagger documentation format)

in your terminal run

spec spec/requests/api/v1/ --format documentation --format Rswag::Specs::SwaggerFormatter

run unit level tests (specs location spec/models)

in your terminal run

rspec spec/models

Usage

on your terminal run

rails server

Visit localhost://3000/api-docs/index.html

Contributor(s)

Victor Okeugo

Contributing

  1. Fork it (https://github.com/johnsonsirv/ankle-arrival-backend/fork)
  2. Create your feature branch (git checkout -b feature/[choose-a-name])
  3. Commit your changes (git commit -m 'What this commit will fix/add')
  4. Push to the branch (git push origin feature/[chosen name])
  5. Create a new Pull Request

    You can also create issues

License

This project is licensed under the MIT License - see the LICENSE file for details.