Skip to content

Commit 75a086d

Browse files
committed
update README
1 parent c38551c commit 75a086d

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# ACM @ UIUC Core
2-
This repository is split into two:
2+
This repository is split into multiple parts:
33
* `src/api/` for the API source code
44
* `src/ui/` for the UI source code
5-
* `src/common/` for common modules between the two (such as types)
5+
* `src/common/` for common modules between the API and the UI (such as constants, types, errors, etc.)
6+
7+
## Getting Started
8+
You will need node>=20 installed, as well as the AWS CLI and the AWS SAM CLI. The best way to work with all of this is to open the environment in a container within your IDE (VS Code should prompt you to do so: use "Clone in Container" for best performance). This container will have all needed software installed.
9+
10+
Then, run `yarn` to install all packages, and `yarn dev` to start the UI and API servers! The UI will be accessible on `http://localhost:5173/` and the API on `http://localhost:8080/`.
11+
12+
**Note: there is currently a known performance issue with running the UI development server in a container. If your requests are timing out, try going to `src/ui` and running `yarn preview` to generate a non development server build.**

0 commit comments

Comments
 (0)