Skip to content

Commit 24e8fc1

Browse files
author
Waren Gonzaga
committed
Add development instructions
1 parent b969a02 commit 24e8fc1

File tree

1 file changed

+38
-2
lines changed

1 file changed

+38
-2
lines changed

README.md

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,44 @@ Here's the screeshot of the tracker on CLI...
136136

137137
## White Label / Personalize / Custom / Development
138138

139-
Working on it...
139+
### White Label / Personalize / Custom Build
140+
141+
> We are still working on this part...
142+
143+
### Development
144+
145+
Wanna improve the project? Follow our guidelines!
146+
147+
```bash
148+
# clone the repo
149+
git clone https://github.com/warengonzaga/covid19-tracker-cli.git
150+
```
151+
152+
```bash
153+
# go to the project folder
154+
cd covid19-tracker-cli
155+
```
156+
157+
```bash
158+
# run npm
159+
npm install
160+
```
161+
162+
```bash
163+
# start the program by default it runs on port 7070
164+
npm run start
165+
166+
# curl to your local this is equivalent to https://trackercli.com
167+
curl localhost:7070
168+
169+
# if you want to curl https://trackercli.com/ph then append /ph to the local host
170+
curl localhost:7070/ph
171+
```
172+
173+
```bash
174+
# run this if you want to develop the program without restarting the server manually, everytime you save the file it will restart the server automagically
175+
npm run dev
176+
```
140177

141178
## Regional Trackers
142179

@@ -157,7 +194,6 @@ If you're facing a problem in using COVID-19 Tracker CLI please let me know by c
157194

158195
## To Do
159196

160-
* Local Version
161197
* Add Static Version
162198
* Sample Usage (gif)
163199
* Add HTTP Headers (currently F)

0 commit comments

Comments
 (0)