Skip to content

Commit 46e596e

Browse files
committed
feat: add concurrently (#418)
1 parent 003b5b2 commit 46e596e

File tree

3 files changed

+151
-3
lines changed

3 files changed

+151
-3
lines changed

README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -94,11 +94,13 @@ git checkout -b [branch name]
9494
3. Once your feature is ready, [open a pull request](https://github.com/icssc/peterportal-client/compare) and a member from our team will review it. Follow the pull request template.
9595
9696
## Running the project locally (after setup)
97-
1. Open two terminal windows and `cd` into the directory of your repo in each of them.
97+
1. Open a terminal in the root directory of the repo.
9898
99-
2. In the first terminal window, enter the client directory with `cd site`. Then run the Vite development server using `npm run dev`. Ensure the server is running on port 3000 by default.
99+
2. Run `npm run dev` to start both the backend Express server and frontend Vite dev server
100100
101-
3. In the second terminal window, enter the API directory with `cd api`. Then run the Express development server using `npm run dev`. Ensure the server is running on port 8080 by default.
101+
3. Visit the link printed to the console by Vite!
102+
103+
Optionally, you can run the site/api separately by changing into their respective directories in two different terminal windows and running `npm run dev`
102104
103105
## Our Mission
104106
🎇 Our mission is to improve the UCI student experience with course planning

package-lock.json

+144
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
"name": "peterportal-root",
33
"version": "0.1.0",
44
"scripts": {
5+
"dev": "concurrently -n backend,frontend -c blue,green \"cd api && npm run dev\" \"cd site && npm run dev\"",
56
"postinstall": "cd api && npm install && cd ../site && npm install",
67
"prepare": "husky install",
78
"format": "prettier --write **/*.{scss,js,ts,tsx}",
@@ -15,6 +16,7 @@
1516
"node": "^18 || ^20"
1617
},
1718
"devDependencies": {
19+
"concurrently": "^8.2.2",
1820
"husky": "^8.0.0",
1921
"lint-staged": "^15.2.0",
2022
"prettier": "^3.1.0"

0 commit comments

Comments
 (0)