@@ -17,19 +17,22 @@ Please add any missing content to this readme.
1717## Development Setup
1818
1919### Install git
20+
2021See https://git-scm.com/downloads for instructions.
2122
2223### Install Node.js
23- _ Node.js version 8.x works best for now; later versions have exhibited some strange behaviour with this project.
24+
25+ _ Node.js version 12.x works best for now; later versions have exhibited some strange behaviour with this project.
2426If you encounter issues with the server, check your version of Node.js first._
2527
2628We recommend using [ nvm] ( https://github.com/nvm-sh/nvm ) to install and manage your Node.js instances.
2729
28- Alternatively, you can install Node.js directly from https://nodejs.org/dist/latest-v8 .x/
30+ Alternatively, you can install Node.js directly from https://nodejs.org/dist/latest-v12 .x/
2931
3032_ On MacOS, you can alleviate the need to run as sudo by using nvm or by [ following John Papa's instructions] ( http://jpapa.me/nomoresudo ) ._
3133
3234### Clone this project
35+
33361 . Open terminal
34371 . Go to a folder where you would like to install the project. Then type the following:
3538
@@ -38,13 +41,15 @@ git clone https://github.com/Greenstand/treetracker-admin.git
3841```
3942
4043### Project Setup
44+
4145Once cloned, type:
4246
4347```
4448cd treetracker-admin/server && touch .env src/datasources/treetracker.datasource.json
4549```
4650
4751This sets up the following:
52+
4853- A ` treetracker.datasource.json ` file in ` server/src/datasources/ ` that will be used to reference the source of data for Loopback.
4954- A ` .env ` file in ` server ` that will contain a JWT secrect.
5055
@@ -76,7 +81,7 @@ Once Docker is installed, lauch Docker from the Applications GUI.
7681
7782For most versions of Windows: [ Docker for Windows] ( https://docs.docker.com/docker-for-windows/install/ )
7883
79- For some older versions or Win10 Home: [ Docker Toolbox] ( https://docs.docker.com/toolbox/toolbox_install_windows/ ) .
84+ For some older versions or Win10 Home: [ Docker Toolbox] ( https://docs.docker.com/toolbox/toolbox_install_windows/ ) .
8085At least on one machine, to get this to work, when you get to the step to do QuickStart terminal script, instead, run:
8186
8287```
@@ -91,7 +96,7 @@ then re-run the QuickStart terminal script.
9196#### Linux
9297
9398To install on linux, you can run
94- ``` sudo apt-get install -y docker-ce `` `
99+ ` sudo apt-get install -y docker-ce `
95100but there is [ additional setup] ( https://docs.docker.com/install/linux/docker-ce/ubuntu/#set-up-the-repository ) to verify keys, etc.
96101
97102### Install, build docker containers and go
@@ -171,6 +176,7 @@ REACT_APP_API_ROOT=http://localhost:3000
171176So the React App would connect to http://localhost:3000 for API server.
172177
173178#### Start server
179+
174180```
175181cd server
176182NODE_ENV=development ./node_modules/.bin/nodemon
@@ -181,12 +187,14 @@ NODE_ENV=development ./node_modules/.bin/nodemon
181187> Using ` nodemon ` to run the server rather than ` npm start ` automatically refreshes the server when files change.
182188
183189#### Start client
190+
184191```
185192cd client
186193npm start
187194```
188195
189196#### View the Treetracker Admin Panel
197+
190198Visit http://localhost:3001
191199
192200## Quick Start For API only development
@@ -395,4 +403,3 @@ npm run watch
395403In this way, we can write the code and get the tests result immediately.
396404
397405NOTE when run tests, the files related to Loopback are loading from ./dist folder, that's because for Jest, it do not output compiled files totally.
398-
0 commit comments