Skip to content

Commit

Permalink
doc: Update instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
mizlan committed Oct 18, 2024
1 parent 246ae19 commit 4985425
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,31 +20,29 @@ Want to find out more about ACM Teach LA, or join the developer team? Check out

## Developer Setup

You'll need:
We use `pnpm`: `pnpm` does what `npm` does but is much more efficient.
Recommended setup is as follows:

- [Node](https://nodejs.org/en/) (we develop this with Node v20.11.0 LTS)
- `npm` (which comes with Node)
- [git](https://git-scm.com/)

Then install `pnpm` ([instructions](https://pnpm.io/installation)). `pnpm`
does what `npm` does but is much more efficient. Also, it can manage different
`node` versions for you.
1. Follow installation instructions for `pnpm` [here](https://pnpm.io/installation).
2. Open a new shell and verify that `pnpm` is installed by running `pnpm --version`.
3. Run `pnpm env use --global lts` to download the latest LTS version of Node.
4. Clone this repository and navigate to the project directory within your shell.
5. Run `pnpm install` to install all dependencies.
6. Test that everything works by running `pnpm staging_start` to start the development server.

There are actually two different ways to run the app locally on your machine -
one that uses our staging backend server, and one where you'll run it locally.
Usually, the staging server is totally fine to use, but having the backend
makes more sense if you're working on a new feature or are editing the backend.
one that uses our staging backend server (as in step 6), and one where you'll
run it locally. Usually, the staging server is totally fine to use, but having
the backend makes more sense if you're working on a new feature or are editing
the backend.

### Connecting to a backend

#### Using the Staging Server (Recommended)

We'll follow the standard node project workflow. Type the following lines into your command line:
After following the **Developer Setup**, run:

```bash
$ git clone https://github.com/uclaacm/TeachLAFrontend.git
$ cd TeachLAFrontend
$ pnpm install
$ pnpm staging_start
```

Expand All @@ -54,6 +52,8 @@ also manually visit it on `localhost:5173`

#### Using a Local Server (Advanced)

**Note** This currently doesn't work.

Here, you'll run our backend on your local machine, which offers more
flexibility; you can find more information on that
[here](https://github.com/uclaacm/teach-la-go-backend).
Expand Down

0 comments on commit 4985425

Please sign in to comment.