Tea Time

Tea, delivered just in the nick of time.
Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
   • Testing
3. Schema
4. Endpoints
5. Contributing
6. Contact
7. Acknowledgements

About The Project

The goal of this project is to create a Rails API for a Tea Subscription Service within a time limit of approximately 8 hours.

The minimum endpoints asked for are:

• An endpoint to subscribe a customer to a tea subscription
• An endpoint to cancel a customer’s tea subscription
• An endpoint to see all of a customer’s subscriptions (active and cancelled)

Getting Started

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

Prerequisites

» Ruby version 2.7.2
» Rails version 5.2.6

Installation

1. Clone the repo

   git clone https://github.com/lcpulzone/tea_time.git

2. Install gems

   bundle install

3. Run

   rails db:{create,migrate}

Testing

RSpec

1. To run testing suite

bundle exec rspec

Schema

See the open issues for a list of proposed features (and known issues).

Endpoints

DESCRIPTION	ACTION	PATH
create a new tea	POST	localhost:3000/api/v1/teas
create a new customer	POST	localhost:3000/api/v1/customers
create a new subscription	POST	localhost:3000/api/v1/customers/<customer_id>/subscriptions
update a customer's subscription status	PATCH	localhost:3000/api/v1/customers/<customer_id>/subscriptions/<subscription_id>
get all a customer's subscriptions	GET	localhost:3000/api/v1/customers/<customer_id>/subscriptions

Contributing

Contributions are what make the open source community such an amazingly rad place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/RadFeature)
3. Commit your Changes (git commit -m 'Add some RadFeature')
4. Push to the Branch (git push origin feature/RadFeature)
5. Open a Pull Request

Contact

Leigh Cepriano Pulzone - Linkedin - GitHub - Email

Project Link: Tea Time

Acknowledgements

» README Template Source
» Turing Requirements