GeoArt

A web app for public art creators and admirers.

Features include:

• An evolving city map filled with artistic hot-spots
• A scavenger hunt experience that brings people into town to explore art in its native context
• A community to discuss art, make connections and build shared portfolios

View the Design Mockup

Getting Started

1. Clone this repo: git clone https://github.com/Waidhoferj/CSC-308-309-Project.git
2. Follow setup instructions for frontend and backend
3. With both the frontend and backend development servers running, open http://localhost:3000 to view the app in the browser.

Resources

• Frontend
• Backend

Style Guides

Python Files

Usage:

• Run "pipenv install" then "pipenv shell" in backend folder
• "pycodestyle file.py" with no errors for each file added to git before commiting

Javascript Files

Usage:

• Installation Guide

Continuous Integration

When a PR is added to the repo, the following checks are run:

• Netlify site config and build checks
• GraphQL test suite located in testing.py

Upon merge:

• The frontend folder containing the React app is deployed on Netlify
• The backend folder containing the GraphQL API is deployed to Heroku.

Acceptance Tests

Acceptance tests are important for defining user flows in a way that all stakeholders can understand. We used the Gherkin Language to describe the user flows and Cypress to create automated tests around the spec.

• Acceptance test documents exist in an online document
• Automated tests can be found in the integration folder

To run Cypress tests:

1. Navigate to the frontend folder
2. Run npm run cypress
3. When Cypress boots up, select the test you want to run.

Unit/Integration Tests

Unit and integration tests are crutial in confirming the functionality of our program. We maintain a testing file on the backend that contains all of our unit tests for our GraphQL api.

• See our wiki for details about unit testing coverage for the backend: https://github.com/Waidhoferj/CSC-308-309-Project/wiki/Unit-Integration-Test-Coverage