From 007dfae34d702d8750910f255bedad66db34c653 Mon Sep 17 00:00:00 2001 From: Sean Kelly <62915047+brok3turtl3@users.noreply.github.com> Date: Thu, 30 Nov 2023 16:30:29 -0500 Subject: [PATCH 1/2] Create pull_request_template.md --- pull_request_template.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 pull_request_template.md diff --git a/pull_request_template.md b/pull_request_template.md new file mode 100644 index 0000000..12fc0ba --- /dev/null +++ b/pull_request_template.md @@ -0,0 +1,31 @@ +Thank you for your contribution to Code Hammers's repository! Before merging, please fill out this brief form. + +### Description + +(What does this PR do? What problem does it solve? What feature does it add? What is the impact of this change? What other PRs does this depend on? If this PR is a work in progress, please add the `WIP` label.) + +### Jira Task + +(**Replace this text** with a link to your Jira task link here, or N/A) + +### Testing Instructions + +_**Note:** this does not mean pasting in how to run the Jest tests. Let us know if there is a specific flow we need to follow to test the fuctionality on the site itself, or if there is a specific page you want to test, etc. This is not needed for most PRs._ + +### Checklist + +Please go through each item of this checklist carefully. + +- [x] (Example checked item. Don't add any spaces around the "x".) + +#### All Team Members + +- [ ] I added a descriptive title to this PR. +- [ ] I filled out the **Description**, **Jira Task**, and **Testing Instructions** sections above. +- [ ] I added or updated [Jest unit tests]for any changes to components, server-side controllers, etc. +- [ ] I ran `npm run docker-test` in my local environment to check that this PR passes all unit tests. +- [ ] I did a quick check to make sure my code changes follow the recomended style guide. + +### Additional Notes, Images, etc. + +(This is space for any additional information or attachments you'd like to add as part of this PR.) From b4f0eb417b96751edab5c4792874ac36e4e17884 Mon Sep 17 00:00:00 2001 From: Sean Kelly <62915047+brok3turtl3@users.noreply.github.com> Date: Thu, 30 Nov 2023 19:55:19 -0500 Subject: [PATCH 2/2] Update README.md --- README.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 963703e..184e8a9 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,9 @@ ## dev environment setup - Clone the repo down to your local machine. -- Run **npm i** in the root directory. -- Run **npm i** in the root of the client folder. - Before servers are spun up you will need to run the initial tailwind script. - - In the **client** folder run **npx tailwindcss -i ./src/input.css -o ./dist/output.css --watch** in your terminal. This will run the inital css build. It will also leave it running and provide live compiles for any changes to styling. -- Open a new terminal and in the **root** run **npm run dev-ts**. This will spin up the backend server and a localhost render on 8080. - -You will ned to set up the .env file. This should include **"NODE_ENV=development"** as well as any database connection strings, api keys, seeder phrases as required. - - + - In the **client** folder run **npx tailwindcss -i ./src/input.css -o ./dist/output.css --watch** in your terminal. You will be prompted to install Tailwind - Choose YES. This will run the inital css build. It will also leave it running and provide live compiles for any changes to styling. +- Open a new terminal and in the **root** run **npm run docker-dev**. This will spin up the containerized backend server and a localhost render on 8080. +- Login credentials for testing are email: tester@codehammers.com, password: ilovetesting +You will need to set up the .env file. This should include **"NODE_ENV=development"** as well as any database connection strings, api keys, seeder phrases as required.