Skip to content

Commit

Permalink
Updated to have some more detail during setup stages
Browse files Browse the repository at this point in the history
  • Loading branch information
marktran2 committed Dec 24, 2024
1 parent d01497f commit 1957edf
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 9 deletions.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,20 @@ You can then access the client at `http://localhost:5173` in your favourite web

### Running the back-end

Navigate into `/server`, install packages with `pnpm i`, then run `pnpm start`. The server will be hosted at `http://localhost:3001`
1. Navigate into `/server`
2. Install packages with `pnpm i`
3. Generate the prisma client with `npx prisma generate`
4. Run `pnpm start`

The server will be hosted at `http://localhost:3001`.

### Running the Notangles DB

1. Open Docker Desktop
2. Navigate into `/server`
3. Run `docker-compose up`
4. Terminate from the composed backend with `ctrl + c`
5. Now you will have container that can be restarted to have the database running

### Running the auto-timetabler

Expand Down
10 changes: 2 additions & 8 deletions client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,14 @@

The Notangles client allows users to interactively plan out their timetables with the latest course information using a simple drag-and-drop system.

## Installation
## Installation & Running

The client has been verified to work with:

- npm v8.3.1
- node v16.14.0

In the root client directory `client`, run `npm install` to install all the dependencies.

## Running

Use `npm start` to host the Notangles client locally. The client will be hosted on http://localhost:3000.

Recommended: To connect to the real timetabling server, use `npm run start:mock` instead.
Follow the installation & running steps as outlined in [Notangles README.md](https://github.com/devsoc-unsw/notangles?tab=readme-ov-file#running-the-front-end)

## Tech stack

Expand Down

0 comments on commit 1957edf

Please sign in to comment.