Student ArtCo Frontend

You can find the deployed project at Student ArtCo.

Contributors

Ami Scott	dAVE Inden	Jason Loomis

Ian Schwartz	Grissobel Payonk	Mackenzie Weber

Project Overview

Trello Board

Product Canvas

UX Design files

Student ArtCo is an application to help schools raise money to fund their art programs by offering student art in exchange for donations. Many art students have said their finished projects end up in the garbage or collecting dust. With our app schools or art teachers can accept art donations from students and list them for sale. Family, members of the community, and art lovers can browse the art listings and connect with the school to make a donation and collect the art.

Key Features

• Schools can create accounts and list art created by students for sale.
• Buyers can browse art and find pieces they like and then contact the school to make a purchase.

Tech Stack

Front end built using:

React

• State management is helpful in creating the user interface and interactions we are looking for.
• Lots of great packages to do things effeciently.

Front end deployed to Netlify

Back end built using:

Node and PostgreSQL

• Relational database structure will make for a clean and effecient database and schema that makes sense.

GraphQL

• Allows us to get just the data we need.
• Requests are easy to make for web, iOS, and Android so they can all get the info they would like for their needs.

APIs

Firebase Authentication

Firebase Authentication allows for us to have secure access to our application by our users. The users all get unique identifiers set for them that we can connect to their data in our database.

Stripe

Industry standart for payments. Safe and secure, easy to set up, will allow customers to purchase art work easily.

Cloudinary

Media management API will be used to upload images of the artwork

Environment Variables

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_FIREBASE_API_KEY - Info found from Firebase App Config for your Firebase project
* REACT_APP_FIREBASE_AUTH_DOMAIN - Info found from Firebase App Config for your Firebase project
* REACT_APP_FIREBASE_DATABASE_URL - Info found from Firebase App Config for your Firebase project
* REACT_APP_FIREBASE_PROJECT_ID - Info found from Firebase App Config for your Firebase project
* REACT_APP_FIREBASE_STORAGE_BUCKET - Info found from Firebase App Config for your Firebase project
* REACT_APP_FIREBASE_MESSAGING_SENDER_ID - Info found from Firebase App Config for your Firebase project
* REACT_APP_FIREBASE_APP_ID - Info found from Firebase App Config for your Firebase project
* REACT_APP_FIREBASE_MEASUREMENT_ID - Info found from Firebase App Config for your Firebase project
* REACT_APP_UPLOAD_PRESET - Unique value assigned by Cloudinary
* REACT_APP_CLOUD_NAME - Cloud name found in Cloudinary account

Testing

Front end testing done with React Testing Libarary. Backend testing was done with Jest. See below in Installation Instructions for command to run the tests.

Installation Instructions

In the project folder run yarn or npm i to get dependencies.

Other Scripts

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

Contributing

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.

Issue/Bug Request

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.

Feature Requests

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.

Pull Requests

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.

Pull Request Guidelines

• 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.

Attribution

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

Documentation

See Backend Documentation for details on the backend of our project.
Documentation for the Android client can be found here.
iOS client documentation is here.