Bring A Jacket

Mod 3 Final Project
· Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Database Tables
4. Requests and Responses
5. Contributing
6. Contact
7. Acknowledgments

About The Project

Bring a Jacket is a road trip planning application that will allow users to see the current weather as well as the forecasted weather at the destination. This project was made as part of the Module 3 curriculum for the Turing School of Software and Design. This version is currently only the backend of the project.

The learning goals of this project are as follows:

• Expose an API that aggregates data from multiple external APIs
• Expose an API that requires an authentication token
• Expose an API for CRUD functionality
• Determine completion criteria based on the needs of other developers
• Test both API consumption and exposure, making use of at least one mocking tool (VCR, Webmock, etc).

This project uses the following technology stack:

• Ruby 3.1.1
• Rails 7.0.4
• PostgreSQL as the database for Active Record
• Puma web server
• bcrypt for password security
• Faraday for making HTTP requests
• Bootsnap for caching to reduce boot times
• Figaro for managing application configuration
• JSON API Serializer for generating JSON responses

Additionally, the project uses several gems for development and testing, such as Capybara, RSpec, Faker, and Shoulda Matchers.

Back to top

Built With

Back to top

Getting Started

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

Prerequisites

This is an example of how to list things you need to use the software and how to install them. You must have the following software installed on your system:

• Ruby
• Bundler
• PostgreSQL

Installation

1. Clone the repo

   git clone git@github.com:brad-dunlap/bring_a_jacket.git

2. Install dependencies

   bundle install

3. Configure the database by running rails db:setup:

   rails db:setup

4. Start the server by running rails server:

   rails server

5. Visit http://localhost:3000 in your web browser to confirm that the app is running or use an application such as Postman to make your API calls to check the appropriate responses.

Back to top

Database Tables

Users:

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

Back to top

Requests and Responses

Weather Requests

Registration Requests

Login Requests

RoadTrip Requests

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

Contact

Bradley Dunlap
Github: brad-dunlap

Back to top

Project Manager

• Mike Dao and Abdul Redd (instructor team)

Back to top

Acknowledgments

• "The Best README Template" by Github User othneil

Back to top