Skip to content

Commit efe7b97

Browse files
committed
docs: update readme
1 parent 02c58ba commit efe7b97

File tree

1 file changed

+7
-15
lines changed

1 file changed

+7
-15
lines changed

README.md

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# atlas
1+
# Atlas
22

33
## UGRC Web Mapping Application Template
44

@@ -9,28 +9,24 @@
99

1010
### Step 1 - Use this template
1111

12-
Click the `Use this template` button to create a new repository from atlas
13-
14-
or
15-
16-
Checkout repository and install dependencies
12+
Click the `Use this template` button to create a new repository from atlas or checkout the repository
1713

1814
```bash
1915
git clone https://github.com/agrc/atlas.git
2016
cd atlas
2117
```
2218

23-
Duplicate the `.env` file and rename it as `.env.local` and update the properties with your data
19+
Duplicate the `.env` file and rename it as `.env.local` to add your local secrets.
2420

25-
Download all the dependencies
21+
Install the project dependencies
2622

2723
```bash
2824
npm install
2925
```
3026

31-
### Step 2 - Develop & Test
27+
### Step 2 - Develop and Test
3228

33-
Execute `npm start` to start a web server and view the website
29+
Run `npm start` to start a web server and view the website
3430

3531
Open [`src/App.jsx`](src/App.jsx) to view the development version of the app.
3632

@@ -48,14 +44,10 @@ Execute `npm run build` to create an optimized production build
4844

4945
_The files will be placed in `/dist`_
5046

51-
Execute `npm run preview` to view the website
47+
Execute `npm run preview` to view the built website
5248

5349
### Step 4 - Deploy
5450

55-
One-time tasks:
56-
57-
- [ ] Update the analytics code in `index.html`
58-
5951
This website is tested and deployed with GitHub Actions.
6052

6153
### Contributing

0 commit comments

Comments
 (0)