HAP API

An API-only app consumed by the HAP frontend via token-based authentication with devise-token-auth.

MVP Features

The MVP endpoints include:

• GET /hikes
• GET /bookings
• POST /auth
• POST /auth/sign_in
• DELETE /auth/sign_out
• POST /hikes/{id}/appointments

🧰 Tools & Technologies Used

Built with

• Ruby v2.6.5
• Ruby on Rails v5.2.4
• RSpec >=3.8.0
• PostgreSQL >=9.5

🚀 Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Ruby: 2.6.5

Rails: 5.2.3

gem install rails -v 5.2.3

PostgreSQL: >=9.5

Setup

Clone repo into your local environment:

Clone with SSH

git clone git@github.com:cliftondavies/HAP-API.git

Clone with HTTPS

git clone https://github.com/cliftondavies/HAP-API.git

Open project directory

cd [your-directory-name]

Install gems:

bundle install

Set up database:

rails db:create
rails db:migrate

Local Usage

In console

Start console:

rails console

In Browser

Start server:

rails server

Open http://localhost:3000/ in your browser.

Deploy

heroku create

git push heroku master

heroku run rails db:migrate

heroku run rails db:seed

heroku open

Author

👤 Clifton Davies

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

🤝 Contributing

Contributions, issues and feature requests are welcome!

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

• Postman
• HTTPie

📝 Copyright & License

Copyright (c) 2020 Clifton Davies. This project is licensed under MIT. See LICENSE file for details.