Backend deployed at Heroku
Backend manual testing playground at Heroku
Backend staging at Heroku
Backend manual testing playground at Heroku
To get the server running locally:
- Clone this repo
- yarn install to install all required dependencies
- yarn dev to start the local server
- yarn test to test, please run yarn dev to start the local server, yarn knex migrate:latest --env development to get a development database loaded up on your local machine, and yarn knex seed:run --env development, to seed that database with therequired files. You will need to reseed the database every time you run the tests!
The backend is built with Node.js, Express, and GraphQL. Node.js and Express and used to serve the route needed to host the GraphQL endpoint. The database is Postgres for production and staging with SQLite3 usedfor local development. Knex is used to manage the database implementation in all environments.
| Method | Endpoint | Access Control | Description |
|---|---|---|---|
| POST | https://student-artco.herkuapp.com/graphql |
all users | Entry point for all queries and mutations |
Version: 1.0
| Fields | Requires | Returns |
|---|---|---|
| allSchools | School array | |
| allArts | Art array | |
| allCategories | Category array | |
| schoolBySchoolId | Schools table Primary Key | School |
| art | Art table Primary Key | Art |
| category | Categories table Primary Key | Category |
| Fields | Parameters | Returns |
|---|---|---|
| addSchool | school_name, email, address, city, zip | School |
| addArt | category, school_id, price, sold, title, artist_name, description, image_url | Art |
| updateArt | id, category, price, sold, title, artist_name, description | Art |
| deleteArt | id | Art |
| sendMail | sendTo, name, subject, fromUser, message | Contact |
| Type | Fields |
|---|---|
| School | id, school_id, school_name, email, address, city, zipcode, art |
| Art | id, school_id, price, sold, title, artist_name, description, date_posted, school, category, images |
| Image | id, image_url, art_id |
| Category | id, category |
| Contact | sendto, name, subject, fromUser, message |
query {
allArts {
# can return...
id
school_id
price
sold
title
artist_name
description
date_posted
school {
id
school_name
email
address
city
zipcode
}
category {
id
category
}
images {
id
image_url
art_id
}
}
}
mutation {
addArt(
category: 1
school_id: 1
price: 50
title: "Fugue with Confused Execution"
artist_name: "Myron Medina"
description: "A damaged, jealous, locket."
image_url: "https://example.com" # this is generated by Cloudinary
) {
# can return...
id
school_id
price
sold
title
artist_name
description
date_posted
school {
id
school_id
school_name
email
address
city
zipcode
}
category {
id
category
}
images {
id
image_url
art_id
}
}
}
In order for the app to function correctly, the user must set up their own environment variables.
create a .env file that includes the following:
PORT = Whatever free port you have open will work fine, if 4000 is not available.
DATABASE_URL = This environment variable does not need to be set up locally, but is set by Heroku when enabling the postgres addon.
DB_ENV = This will default to 'development'. If you wish to use testing, please run the script yarn test to run the app in the testing environment. This needs to be configured on Heroku to be set to 'production' (no quotes needed when setting the variable).
SGUS = The username for SendGrid, you will need access to student-artco's SendGrid account or have one of your own.
SGPW = The password for SendGrid, you will need access to student-artco's SendGrid account or have one of your own.
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 Frontend Documentation for details on the web client of our project.
Documentation for the Android client can be found here.
iOS client documentation is here.