From 1957edf1ab4b882f00afe105ec22cc0f55a9ee5d Mon Sep 17 00:00:00 2001 From: Mark Tran <29350857+marktran2@users.noreply.github.com> Date: Tue, 24 Dec 2024 22:10:48 +1100 Subject: [PATCH] Updated to have some more detail during setup stages --- README.md | 15 ++++++++++++++- client/README.md | 10 ++-------- 2 files changed, 16 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 7a6f6862e..8c5e6ca87 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/client/README.md b/client/README.md index 830c28433..7ea565724 100644 --- a/client/README.md +++ b/client/README.md @@ -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