Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add concurrently #418

Merged
merged 4 commits into from
Feb 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,11 +94,13 @@ git checkout -b [branch name]
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.

## Running the project locally (after setup)
1. Open two terminal windows and `cd` into the directory of your repo in each of them.
1. Open a terminal in the root directory of the repo.

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.
2. Run `npm run dev` to start both the backend Express server and frontend Vite dev server

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.
3. Visit the link printed to the console by Vite!

Optionally, you can run the site/api separately by changing into their respective directories in two different terminal windows and running `npm run dev`

## Our Mission
🎇 Our mission is to improve the UCI student experience with course planning
Expand Down
144 changes: 144 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"name": "peterportal-root",
"version": "0.1.0",
"scripts": {
"dev": "concurrently -n backend,frontend -c blue,green \"cd api && npm run dev\" \"cd site && npm run dev\"",
"postinstall": "cd api && npm install && cd ../site && npm install",
"prepare": "husky install",
"format": "prettier --write **/*.{scss,js,ts,tsx}",
Expand All @@ -15,6 +16,7 @@
"node": "^18 || ^20"
},
"devDependencies": {
"concurrently": "^8.2.2",
"husky": "^8.0.0",
"lint-staged": "^15.2.0",
"prettier": "^3.1.0"
Expand Down
Loading