Skip to content

Commit e7e0cea

Browse files
committed
update gitignore and readme
1 parent ec671b0 commit e7e0cea

File tree

2 files changed

+25
-4
lines changed

2 files changed

+25
-4
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
22

33
# dependencies
4-
/node_modules
4+
**/node_modules
55
/.pnp
66
.pnp.js
77

README.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,26 @@
11
# CSESoc Website
22

3-
## How to run locally
4-
- Install dependencies with `npm install`
5-
- Run using `npm run dev`
3+
This repository contains the code for a redesigned CSESoc website. The current website can be found at [csesoc.unsw.edu.au](https://csesoc.unsw.edu.au/).
4+
5+
## How to run locally (without Docker, development mode)
6+
7+
### Running the frontend
8+
9+
1. Navigate to the `frontend` directory with `cd frontend`.
10+
2. Install dependencies with `npm install` if you haven't already.
11+
3. Run using `npm run dev`, changes will be reflected live.
12+
13+
See `package.json` for further commands to lint, build, etc.
14+
15+
### Running the backend
16+
17+
1. Navigate to the `backend` directory with `cd backend`.
18+
2. Install dependencies with `npm install` if you haven't already.
19+
3. Run using `npm run dev`, changes will be reflected live.
20+
21+
## How to run locally (with Docker, production mode)
22+
23+
Make sure you have [Docker](https://docs.docker.com/get-docker/) installed.
24+
25+
1. Run `docker-compose up` (or `docker-compose up -d` to run in the background) in the root directory, this will start the frontend and backend services. Note this may be a little slow the first time you run this command. This will build both the frontend and backend services in production mode, meaning live changes will not be reflected.
26+
2. Run `docker-compose down` to stop the services.

0 commit comments

Comments
 (0)