https://github.com/neverstew/cuppa

Pop round for a cuppa
https://github.com/neverstew/cuppa

Last synced: about 2 months ago
JSON representation

Pop round for a cuppa

• Host: GitHub
• URL: https://github.com/neverstew/cuppa
• Owner: neverstew
• Created: 2020-03-27T17:07:06.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-03-31T01:00:23.000Z (almost 3 years ago)
• Last Synced: 2023-06-30T07:06:14.130Z (over 1 year ago)
• Language: Ruby
• Size: 6.74 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        
# cuppa

![Build status](https://github.com/matt-l-w/cuppa/workflows/build/badge.svg)

This is source code for [cuppa](https://covid-cuppa.herokuapp.com). Cuppa was made

as part of the COVID-19 Global Hackathon. To find out more about the motivations and

pathway to building this, see the [project page](https://devpost.com/software/cuppa).

To find out more about cuppa itself, visit the website.

This README will stick to development-related aspects of the project.

## Architecture

The app is hosted on Heroku but also makes use of:

* AWS S3 for static file hosting in production

* Google Maps APIs for location-related information

This is a Rails app, with a sprinkling of React for the more dynamic front-end components.

## Development

### Contributing

This repository is absolutely up for contribution. Please read [our guidance](contributing.md) for contributing first.

### Locally

Requirements:

1. Ruby 2.4.9

1. Node 12.x

1. Postgres

To install and run the app locally, run 

```

bundle install

yarn install

rails db:create

rails db:migrate

rails server

```

This requires you have a postgres instance running and accessible on port 5432.

### CI

On the creation of a PR, a pipeline will launch that:

1. runs the tests

1. spins up a testing environment on Heroku

This should be enough to verify your app is ready for deployment to production.