jeffemmett
/
odd-app-template
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md 

- Add more explicit steps top the `Getting Started` section
- Fix the Download link in the readme
This commit is contained in:
avivash 2023-08-03 09:06:35 -07:00 committed by GitHub
parent 506172ed12
commit 3c3c94b858
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -57,13 +57,19 @@ Prerequiste: ensure you are running Node 16.14 or greater, but _not_ Node 17 (18
git clone git@github.com:oddsdk/odd-app-template.git git clone git@github.com:oddsdk/odd-app-template.git
``` ```
2. Install the dependencies. 2. Navigate to the downloaded template directory:
```shell
cd odd-app-template
```
3. Install the dependencies:
```shell ```shell
npm install npm install
``` ```
3. Start the local development server. 4. Start the local development server:
```shell ```shell
npm run dev npm run dev
@ -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 `appName` to the name of your app.
- Change `appDescription` to a simple, 1-sentence description of your app. - Change `appDescription` to a simple, 1-sentence description of your app.
- Update `oddNamespace` with your project details. - 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. In `package.json`, change `name` to your application's name.