Skip to content

Commit

Permalink
review the getting started steps
Browse files Browse the repository at this point in the history
  • Loading branch information
fgandellini committed Jun 9, 2024
1 parent 0087048 commit cc51a94
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 14 deletions.
20 changes: 7 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,19 +22,13 @@ The project has been tested on Linux only.

1. Ensure you have `nvm` [installed](https://github.com/nvm-sh/nvm?tab=readme-ov-file#installing-and-updating) on your computer.

2. run `npm start`

3. navigate to http://localhost:1234

> [!WARNING]
> If `npm start` fails, it's likely a problem with the automatic `nvm` detection.
>
> Try following these steps:
>
> 1. `cd` in the main directory of this repo
> 2. Run `nvm use`
> 3. Run `npm ci`
> 4. Run `npm run dev`
2. clone this repository and `cd` into it

3. run `nvm install` to install the correct node version (specified in `.nvmrc`)

4. run `npm start` to install dependencies and start the development server

5. navigate to http://localhost:1234

## 🏗️ Project Structure

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"test": "npm t --workspaces",
"build": "npm run build --workspace @2048/react",
"dev": "npm run dev --workspace @2048/react",
"start": "source $HOME/.nvm/nvm.sh && nvm use --delete-prefix && npm ci && npm run dev"
"start": "npm ci && npm run dev"
},
"keywords": [
"2048",
Expand Down

0 comments on commit cc51a94

Please sign in to comment.