Skip to content

Commit 916e8f9

Browse files
committed
chore: update README w/ docker-compose instructions
1 parent 96f6732 commit 916e8f9

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ https://nameless-eyrie-75082.herokuapp.com/
1010
```
1111
1. Internet connection
1212
2. NodeJS (https://nodejs.org/)
13-
3. Sublime Text Editor (optional: I use WebStorm)
14-
4. MongoDB (you can use www.mlab.com)
15-
5. Elastic Search (https://www.elastic.co/):
13+
3. VS Code (optional: I use WebStorm)
14+
4. MongoDB (you can use www.mlab.com or Docker alternative)
15+
5. Elastic Search (https://www.elastic.co/ or Docker alternative):
1616
Download version 1.7.5 others are not compatable
1717
6. Stripe account
1818
```
1919
### Instructions
20-
Open the project in Sublime Text, and navigate to config folder. Open the config.js in the editor:
20+
Open the project in VS Code, and navigate to config folder. Open the config.js in the editor:
2121

2222
Add mongodb URL:
2323
```
@@ -43,19 +43,20 @@ number retrieved from Stripe.com
4343

4444
Now that we are set. Open project in terminal, and:
4545
```
46-
yarn install (this will install all dependencies)
46+
npm install (this will install all dependencies)
4747
```
4848

4949
Once all dependencies are installed
5050
```
51-
yarn start
51+
npm start
5252
```
5353

5454
aggg!! Project does not run
5555
```
5656
* Make sure Elasticsearch is running (version 1.7.5).
5757
* If using MongoDB locally, make sure it is running as well.
5858
```
59+
alternatively if you have Docker and Docker compose installed then simply docker-compose up. This will install and run MongoD and ElasticSearch.
5960

6061
## Testing
6162

@@ -64,7 +65,7 @@ number retrieved from Stripe.com
6465

6566
``started on automating this``
6667

67-
To run automated UI tests, run ```yarn test```
68+
To run automated UI tests, run ```npm run test```
6869

6970
The tests are written using the Cypress framework (https://www.cypress.io)
7071

@@ -106,4 +107,4 @@ WIP: add more instructions on setting up Docker and Kubernetes including monitor
106107
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
107108
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
108109
SOFTWARE.
109-
```
110+
```

0 commit comments

Comments
 (0)