Tea Time



Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. API Contract
  4. Schema
  5. Issues
  6. Contributing
  7. License
  8. Contributors
  9. Acknowledgments

About The Project

Have you ever ran out of your favorite tea when you were craving it the most? Are you concerned about fairtrade products and want to buy from an ethically sourced company?

Tea Time is a subscription service that allows you to choose your favorite tea and have it delivered to your door every month, or twice a month. This application allows customers to choice their tea and subscription plan, as well as cancel their subscription and see all of their subscriptions, both active and cancelled.

Project Link:
GitHub Project Link

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

  • Ruby on Rails
  • Ruby Gems

(back to top)

Getting Started

Prerequisites

  • Ruby 3.1.1
  • Rails 7.0.4.3

Installation

  1. Clone the repo
    git clone git@github.com:MATrevino/tea_time.git
  2. Install gems
    bundle install
  3. Set up the database
    rails db:{create,migrate,seed}
  4. Run the RSpec Tests
    bundle exec rspec

(back to top)

API Contract

Tea Time API Contract

Create subscription query_http_url request body: request
response body: response

Cancel subscription query_http_url request body: request
response body: response

  1. All subscriptions query_http_url request body: none

response body: ![response](images/all_subs_response.png)

(back to top)

Schema

Database_Schema

(back to top)

Requests

creates_subscription Query

(back to top)

Postman Queries

#add if time allows

(back to top)

Issues

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

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contributors

Meredith Trevino

| Meredith Trevino |
| Collaborator |
GitHub
LinkedIn

(back to top)

Acknowledgments

These are some of the resources we used for the project and the README.

ReadMe Resources

(back to top)