Chore/#153928513 - Add project architecture guide (#125)

* chore(docs): Add architecture guide (unfinished)

* chore(docs): Add code of conduct

- just to finish off the docs

* chore(docs): update architecture guide

* chore(docs): add pr template, update contributing

- add link for pr section to put in pr template
- add 'Branch Updating and Conflicts' section to CONTRIBUTING

* chore(docs): Add front-end/back-end guides links (#122)

* chore(docs): update PR template

* chore(docs): update architecture guide

- project structure change
- add client architecture section
- add server architecture section

* chore(docs): update contributing doc & pr template

* chore(docs): remove comma

* chore(docs): update PR template

* chore(docs): update project structure section

* chore(docs): update client architecture section

* chore(docs): add server architecture section

* chore(docs): update architecture guide

* chore(docs): update PR template wording

* chore(scripts): update start/stop/restart scripts

* chore(docs): update README

* chore(docs): update CONTRIBUTING

* chore(docs): add `yarn lint` to scripts cheatsheet

* chore(docs): update a few more things
[#153928513]

Author: timdavish

Diff for: .setup/db/run.sh

@@ -13,15 +13,18 @@ start () {
   # Make sure a container isn't already running
   if [[ -z "$ID_FROM_DB" && -z "$ID_FROM_NAME" ]] ; then
     echo "--- Starting new docker container with MongoDB.."
-    docker run --name $NAME -d -p 27017:27017 -p 28017:28017 $DB:$IMAGE_VERSION | xargs echo "--- Started container"
+    docker run --name $NAME -d -p 27017:27017 -p 28017:28017 $DB:$IMAGE_VERSION \
+      | xargs echo "--- Started container"
 
     echo "--- Copying seed data to docker container.."
     docker cp ./.setup/db/seedData/users.json $NAME:users.json
     docker cp ./.setup/db/seedData/projects.json $NAME:projects.json
 
     echo "--- Adding seed data to MongoDB.."
-    docker exec $NAME mongoimport --db admin --collection users --file users.json --type json --jsonArray
-    docker exec $NAME mongoimport --db admin --collection projects --file projects.json --type json --jsonArray
+    docker exec $NAME mongoimport --quiet --db admin --collection users \
+      --file users.json --type json --jsonArray
+    docker exec $NAME mongoimport --quiet --db admin --collection projects \
+      --file projects.json --type json --jsonArray
   else
     echo "--- Skipping start, container already running"
     exit 0

Diff for: .setup/email/run.sh

@@ -5,13 +5,14 @@ set +x -e -o pipefail
 NAME=mailhog
 ID_FROM_NAME=$(docker ps -aq -f name=$NAME)
 IMAGE=diyan/mailhog
-   
+
 start () {
   set -u
   # Make sure a container isn't already running
   if [[ -z "$ID_FROM_NAME" ]] ; then
     echo "--- Starting new docker container with MailHog.."
-    docker run --name=$NAME -d -p 1025:1025 -p 8025:8025 $IMAGE | xargs echo "-- Started container"  
+    docker run --name=$NAME -d -p 1025:1025 -p 8025:8025 $IMAGE \
+      | xargs echo "--- Started container"  
   else
     echo "--- Skipping start, container already running"
     exit 0
@@ -20,7 +21,7 @@ start () {
 
 stop () {
   set -u
-  # Make sure there's a container to stop  
+  # Make sure there's a container to stop
   if [[ ! -z "$ID_FROM_NAME" ]] ; then
     ID=$ID_FROM_NAME
   else
@@ -38,12 +39,12 @@ cat <<EOF
   Usage: ./email/run.sh <target>
   Targets:
     start - start a docker container with MailHog mail server
-    stop - stop and remove the docker container    
+    stop - stop and remove the docker container
 EOF
 }
 
 case $1 in
   start)        start         ;;
-  stop)         stop          ;;  
+  stop)         stop          ;;
   *)            info          ;;
 esac

Diff for: README.md

@@ -11,27 +11,31 @@
 
 ## Getting Started
 
-👋 Want to contribute to this project? Follow these steps to get started:
+:wave: Want to contribute to this project? Follow these steps to get started:
 
-- **💻 Environment Setup**: First, you're going to want to make sure your development environment is properly set up. Read through our [development environment setup](docs/DEVELOPER.md) guide.
+- **:computer: Environment Setup**: First, you're going to want to make sure your development environment is properly set up. Go ahead and read through our [development environment setup](docs/DEVELOPER.md) guide.
 
-- **✏️ Contribute**: Once you're set up, you're ready to become a contributor. Make sure you read our [contributing guidelines](docs/CONTRIBUTING.md) before you start working!
+- **:pencil2: Contribute**: Once you're set up, you're ready to become a contributor. Make sure you read our [contributing guidelines](docs/CONTRIBUTING.md) before you start working on a story so that you can learn our workflows.
 
-- **🙋 Ask Questions**: If you're stuck on something, don't be afraid to ask around in [Slack](http://join-our-slack.code4socialgood.org/)! You can also check out our list of [common problems](docs/PROBLEMS.md) to see if your issue is addressed there.
+- **:european_castle: Project Architecture**: We've put together an [architecture guide](docs/ARCHITECTURE.md) to serve as a reference and help reduce the time it takes to familiarize yourself with this project's architecture and codebase.
+
+- **:raising_hand: Questions & Problems**: If you're stuck on something, don't be afraid to ask around in [Slack](http://join-our-slack.code4socialgood.org/)! You can also check out the [docs](docs/), where there is a lot of helpful information including a list of [common problems](docs/PROBLEMS.md).
 
 ## Additional Information
 
 Below is a cheatsheet for the scripts that can be found in `package.json`:
 
 ```bash
-$ yarn                            # Install dependencies (npm install)
-$ yarn db start                   # Restart docker container with mongodb and add seed data (npm run db -- start)
-$ yarn db stop                    # Stop docker container with mongodb (npm run db -- stop)
-$ yarn email start                # Start docker container with MailHog, if it's not already running (npm run email -- start)
-$ yarn email stop                 # Stop docker container with MailHog (npm run email -- stop)
-$ yarn start                      # Run app locally on port 3000 and in watch mode on port 3001 via https (npm start)
-$ yarn test                       # Run tests (npm test)
-$ yarn build                      # Generate distribution (npm run build)
+$ yarn                              # Install dependencies (npm install)
+$ yarn start                        # Start all docker containers and app on port 3000 and on port 3001 via https w/ watch mode (npm start)
+$ yarn stop                         # Stop all docker containers (npm stop)
+$ yarn restart                      # Restart all docker containers and app (npm restart)
+$ yarn test                         # Run linter, test build, and tests (npm test)
+$ yarn e2e                          # Run end-to-end tests (npm run e2e)
+$ yarn lint                         # Run linter (npm run lint)
+$ yarn db <start/stop>              # Start/stop docker container with seeded MongoDB (npm run db -- <start/stop>)
+$ yarn email <start/stop>           # Start/stop docker container with MailHog (npm run email -- <start/stop>)
+$ yarn build                        # Generate distribution (npm run build)
 ```
 
 *Although yarn is recommended, you may also use npm natively. The corresponding npm commands are in parenthesis above.*