Sk/ssf 132 Verify Prettier Check

.env.example

@@ -0,0 +1,5 @@
+DATABASE_HOST=localhost
+DATABASE_PORT=5432
+DATABASE_NAME=securing-safe-food
+DATABASE_USERNAME=postgres
+DATABASE_PASSWORD=PLACEHOLDER_PASSWORD

.github/pull_request_template.md

@@ -1,21 +1,22 @@
 ### ℹ️ Issue
 
-Closes <issue>
+Closes <link to ticket here>
 
 ### 📝 Description
 
 Write a short summary of what you added. Why is it important? Any member of C4C should be able to read this and understand your contribution -- not just your team members.
 
-Briefly list the changes made to the code:
-1. Added support for this.
-2. And removed redunant use of that.
-3. Also this was included for reasons.
+Now, describe the code changes you made to support this. Be specific! This includes describing any design decisions you had to make, and referencing specific classes, files, components, etc., where you made particular changes.
+
+**If you added or modified a page on the frontend, please include its path - e.g., `/pantry-application`. If you added or modified a backend endpoint, please include the HTTP method and the route - e.g., `POST /api/pantries`.** This will make it easier for other people to find and test out your new addition!
 
 ### ✔️ Verification
 
 What steps did you take to verify your changes work? These should be clear enough for someone to be able to clone the branch and follow the steps themselves.
 
-Provide screenshots of any new components, styling changes, or pages. 
+Describe any new unit tests you added.
+
+Provide screenshots of any new components, styling changes, or pages.
 
 ### 🏕️ (Optional) Future Work / Notes
 

.github/workflows/backend-tests.yml

@@ -0,0 +1,39 @@
+on: [push, pull_request]
+
+jobs:
+  prettier-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - run: yarn install
+      - run: yarn prettier:check
+  backend-tests:
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres:15
+        env:
+          POSTGRES_DB: securing-safe-food-test
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+        ports:
+          - 5432:5432
+    env:
+      DATABASE_HOST: 127.0.0.1
+      DATABASE_PORT: 5432
+      DATABASE_NAME_TEST: securing-safe-food-test
+      DATABASE_USERNAME: postgres
+      DATABASE_PASSWORD: postgres
+      NX_DAEMON: 'false'
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - run: yarn install
+      - run: npx jest
+
+

.gitignore

@@ -33,6 +33,7 @@ npm-debug.log
 yarn-error.log
 testem.log
 /typings
+.nx
 
 # System Files
 .DS_Store
@@ -41,3 +42,4 @@ Thumbs.db
 # Environment file
 *.env
 *.env.*
+!.env.example

README.md

@@ -1,35 +1,39 @@
-# Scaffolding
+# Securing Safe Food
 
-<a alt="Nx logo" href="https://nx.dev" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="45"></a>
+## Environment Setup
 
-✨ **This workspace has been generated by [Nx, a Smart, fast and extensible build system.](https://nx.dev)** ✨
+We use yarn for dependency management. Install app dependencies by running this command at the repo root (`ssf`):
 
-## Start the app
-
-To start the development server run `nx serve frontend`. Open your browser and navigate to http://localhost:4200/. Happy coding!
+```
+yarn install
+```
 
-## Running tasks
+To set up your backend, follow the backend-specific instructions [here](apps/backend/README.md).
 
-To run just the frontend (port 4200):
+\*Note: you may need to prefix your `nx` commands with `npx`. For example, to serve the frontend, if:
 
 ```
 nx serve frontend
 ```
 
-To run just the backend (port 3000):
+doesn't work, try:
 
 ```
-nx serve backend
+npx nx serve frontend
 ```
 
-To run both the frontend and backend with one command:
+## Start the app
+
+To start the development server, run one of the following commands:
+
+- To run the frontend at http://localhost:4200/: `nx serve frontend`
+- To run the backend at http://localhost:3000/: `nx serve backend`
+  - The homepage includes the Swagger API documentation.
+
+You can also run both the frontend and backend with one command:
 
 ```
 nx run-many -t serve -p frontend backend
 ```
 
-## Other commands
-
-Run `git submodule update --remote` to pull the latest changes from the component library
-
-When cloning the repo, make sure to add the `--recurse-modules` flag to also clone the component library submodule (e.g. `git clone --recurse-submodules https://github.com/Code-4-Community/scaffolding.git` for the `scaffolding` repo)
+The locally hosted frontend and backend will update live as you make changes to the code. Happy coding!