Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
- Update getting started steps
  • Loading branch information
avivash committed Aug 3, 2023
1 parent 7238367 commit 8021c4a
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,19 +57,25 @@ Prerequiste: ensure you are running Node 16.14 or greater, but _not_ Node 17 (18
git clone git@github.com:oddsdk/odd-app-template-react.git
```

2. Install the dependencies.
2. Navigate to the downloaded template directory:

```shell
cd odd-app-template-react
```

3. Install the dependencies.

```shell
npm install
```

3. Start the local development server.
4. Start the local development server.

```shell
npm run dev
```

4. Navigate to `http://localhost:5173` in your web browser.
5. Navigate to `http://localhost:5173` in your web browser.

## 🛠 Customize your app

Expand All @@ -82,7 +88,7 @@ The app template is designed to be easy for you to _make it your own._ Here's ho
- Change `appName` to the name of your app.
- Change `appDescription` to a simple, 1-sentence description of your app.
- Update `oddNamespace` with your project details.
- Once you [deploy](#deploy) your app, change `appURL` to the production URL.
- Once you [deploy](#-deploy) your app, change `appURL` to the production URL.

In `package.json`, change `name` to your application's name.

Expand Down

1 comment on commit 8021c4a

@vercel
Copy link

@vercel vercel bot commented on 8021c4a Aug 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.