Easy Art Show

A web app that allow artists to share their artworks easily.

Alpha verson: https://easyartshow.com

Development blogs (check development's history for more): https://github.com/AugustanaCSC490Spring23/EasyArtShow/wiki

Contributing guide

How to run

1. Clone the project
2. On your terminal at the project's location, run cd easyartshowand npm install --force and finally npm start
3. The project should be on http://localhost:3000/
4. Everytime you save your code file, it will reflect the new changes on the localhost site.

How to run firebase

1. Download the private .env file (only shared within team)
2. Put the .env file in the src folder
3. Run the app

How to contribute

1. Make sure to create your own brance with this format: [catogory]/[name of the reference] category:

• feature is for adding, refactoring or removing a feature
• bugfix is for fixing a bug
• hotfix is for changing code with a temporary solution and/or without following the usual process (usually because of an emergency)
• test is for experimenting outside of an issue/ticket

Example: feature/authentication To sum up, follow this pattern when branching: git branch <category/reference>

Read more about branching on this site: https://bit.ly/3ktadIr

2. Create a pull request and link it with an issue
3. Assign a reviewer and ping them again on chat to help review
4. Once the review is the done, the code will be merged to the main branch.
5. Be nice and supportive to each other. We got this!

Clean Code practice

1. Make sure your variables, functions' names are meaningful.
2. Follow correct name convention. For JavaScript, it is camelCase. If it is a constant like password, do UPPER_CASE.
3. Document your functions. What does it do. What are the variables. What does it return.
4. Comment on code you think would be hard for your teammates to understand. Don't overdo it.

More on clean code here: https://medium.com/swlh/10-clean-coding-practices-e37ac283184d