You can find the deployed project at https://www.groa.us/.

Brianna Keune	Benjamin Solt	Mariela Gonzales

Billy Gingrich	TJ Katalenas	Cody M Russell

more info on using badges here

Trello Board

Product Canvas

UX Design files

Gróa will use our Discovery Engine to present movies suited to your taste based upon the way in which you talk about movies.

• Uploading Letterboxd ZIP file
• Receiving movie recommendations from Letterboxd data
• Rating movies
• Receiving new more fine tuned recommendations based on what you've recently rated.
• Adding movies to your watchlist

• Facebook maintains and continues to improve this framework.
• 99% backwards compatibility compared to Vues's 90%.
• In consideration of who will most likely work on Groa in the future, we thought React would be easy to jump in the code base.

axios

• for easier to read responses than fetch

@fortawesome/fontawesome-svg-core | @fortawesome/free-regular-svg-icons | @fortawesome/free-solid-svg-icons | @fortawesome/react-fontawesome

• for all fontawesome icons

@material-ui/core | @material-ui/icons | @material-ui/lab |

• for the stars on movie cards

@node-sass

• drier styling

react-ga

• google analytics

react-loading

• for loading screen animation

react-redux | redux-logger | redux-thunk

• for global statemangement

• Accessible documentation
• Good error handling
• Faster to implement than vanilla Node.js

apidoc

• to create easy to read API docs with inline comments

axios

• for easier to read responses than fetch

cors

• allows us to configure to avoid cors issues

body-parser | csv-parser | express-fileupload | unzipper

• to handle uploaded file information

dotenv

• allows node to read our .env files

standard

pg

pg-format

nodemon

In order for the app to function correctly, the user must set up their own environment variables. There should be a .env file containing the following:

REACT_APP_ANALYTICS_ID - this is your Google analytics key, which can be generated in the Google Analytics Console.
REACT_APP_TMDB_API_KEY - this is your API key from TMDb it sources the movie posters we user.

Jest

React Testing Library

history

redux-mock-store

Jest

@types/jest

cross-env

supertest

knex-cleaner

knex

Clone this repo to your local machine.

Run npm i

* build - creates a build of the application
* start - starts the production server after a build is created
* test - runs tests in **tests** directory \* eject - copy the configuration files and dependencies into the project so you have full control over them

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

• Check first to see if your issue has already been reported.
• Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
• Create a live example of the problem.
• Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.

Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

• Ensure any install or build dependencies are removed before the end of the layer when doing a build.
• Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
• Ensure that your code conforms to our existing code conventions and test coverage.
• Include the relevant issue number, if applicable.
• You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

These contribution guidelines have been adapted from this good-Contributing.md-template.

See Backend Documentation for details on the backend of our project.