Welcome to the backend repo for the Tea Subscription website! This repo holds the code responsible for running the database and exposing the API endpoints described in the OpenAPI Documentation. Also be sure to check out the frontend repo!
- Ruby
- Rails
- Postgres (PostgreSQL)
- RSpec
- factory_bot
- simplecov
- Ruby
3.2.2 - bundler gem:
gem install bundler - Postgres
- Clone the repo to your machine:
git clone https://github.com/JarenGarman/tea_subscription_api.git - Open the directory:
cd tea_subscription_api - Install required gems:
bundler install - Setup the database:
bundle exec rails db:{create,migrate,seed}
- To run the entire suite:
bundle exec rake - To run only the model tests:
bundle exec rspec spec/models - To run only the request tests:
bundle exec rspec spec/requests
To view the available endpoints for this API, please visit the OpenAPI Documentation. There you will find the endpoint definitions, required formatting for requests, and example requests and responses (including possible errors and messages).