Plan a date, see the day, visualize your love.
Report Bug

Table of Contents

1. About The Project
2. Getting Started
3. Endpoints
4. Roadmap
5. Contributing
6. Contributors
7. License

About The Project

Couplistic is a romantic event planner. It utilizes the Ticketmaster and Weather APIs to dynamically generate event and daily weather information that a user queries. Search available events and see that day's current weather. Then, add that event to your personal calendar and look forward to having fun with your partner!

The Couplistic backend is an API that aggregates ticket and weather data to its partner frontend application. The frontend repo is located here.

Built With

• RubyOnRails

• Travis

• Faraday

• Figaro

• Factory Bot

• Faker

• Fast JSON API

• Timecop

• RSpec

• Simplecov

• Capybara

• Shoulda-Matchers

• Webmock

• VCR

Initial Setup

1. Fork this repo
2. Clone down your fork

   git clone [email protected]:your-username/couplistic-be.git

3. Install dependencies

   bundle install

4. Create PostgreSQL database

   rake db:{create,migrate}

Getting Started

1. Register for Ticketmaster and Weather API keys.

2. Install Figaro

   bundle exec figaro install

3. Open application.yml

   code application.yml OR atom application.yml (for vscode/atom code editors)

4. Retrieve and paste in ticketmaster and weather API keys as pictured:

   

5. Initialize rails server

   rails s

Endpoints

Utilize Postman or localhost:3000 to call endpoints:

1. GET /api/v1/ticketmaster?city=#{city}&keyword=#{keyword}
   returns the available events and tickets for a specified city and keyword. Swap city and keyword with your own values.

2. GET /api/v1/weather?q=#{location} returns the weather forecast and moon information for a passed location. Swap location with a location of your choosing.

Roadmap

The team utilized a github project board to organize project issues and coordinate workflow across 5 members and 2 repositories. See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. We hope that users provide input to improve their experience and that of others.

Versions

• Ruby 2.5.3
• Rails 5.2.6

Making a Contribution

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

Contributors

Austin Andrade
Brisa Garcia
Kseniya Kudzelich
Mike Foy
Ryan Stemmle

License

Distributed under the WeatherAPI, Ticketmaster and Spotify for devs Licenses. See LICENSES for more information.