Skip to content
This repository was archived by the owner on Oct 15, 2025. It is now read-only.

Commit 944ee33

Browse files
committed
[update] Make npm default for docs
1 parent 3b35595 commit 944ee33

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The docker-compose setup is configured to reboot the bot when any local file cha
4242
Leonel uses MongoDB to store specific information about users, you can create the user accounts by running:
4343

4444
```bash
45-
$ docker-compose run bot yarn db:seed
45+
$ docker-compose run bot npm run db:seed
4646
```
4747

4848
This will execute the script [db:seed][db-seed] in a container to create all the users from Slack's API.
@@ -52,19 +52,19 @@ This will execute the script [db:seed][db-seed] in a container to create all the
5252
You can run `ava` tests in a container, by running:
5353

5454
```bash
55-
$ docker-compose run bot yarn test
55+
$ docker-compose run bot npm test
5656
```
5757

5858
If you want for tests to watch your files, you can run:
5959

6060
```bash
61-
$ docker-compose run bot yarn test -- -w
61+
$ docker-compose run bot npm test -- -w
6262
```
6363

6464
If you want to modify the `DEBUG` env var, you can run:
6565

6666
```bash
67-
$ docker-compose run -e DEBUG="" bot yarn test -- -w
67+
$ docker-compose run -e DEBUG="" bot npm test -- -w
6868
```
6969

7070
#### Shutting Down
@@ -82,20 +82,20 @@ $ docker-compose down
8282
All environment variables in [example env file][env] should be set before running Leonel.
8383

8484
Other requirements:
85-
- Yarn
86-
- NodeJS 7.7.x
85+
- Npm
86+
- NodeJS 12.10.x
8787
- MongoDB
8888

8989
Install dependencies:
9090

9191
```bash
92-
$ yarn
92+
$ npm install
9393
```
9494

9595
Start leonel:
9696

9797
```bash
98-
$ yarn start
98+
$ npm start
9999
```
100100

101101
Things are looking good if the console prints something like:
@@ -107,14 +107,14 @@ Things are looking good if the console prints something like:
107107
bot:main Estamos coneptados al Eslá
108108
```
109109

110-
We have added `yarn start:watch` script which uses Nodemon for convenience during development. This restarts the bot after any change done to source files.
110+
We have added `npm run start:watch` script which uses Nodemon for convenience during development. This restarts the bot after any change done to source files.
111111

112112
#### Seed users
113113

114114
Leonel uses MongoDB to store specific information about users, you can create the user accounts by running:
115115

116116
```bash
117-
$ yarn db:seed
117+
$ npm run db:seed
118118
```
119119

120120
This will execute the script [db:seed][db-seed] to create all the users from Slack's API.
@@ -125,13 +125,13 @@ This will execute the script [db:seed][db-seed] to create all the users from Sla
125125
We use ava for unit and integration testing, you can run tests by typing:
126126

127127
```bash
128-
$ yarn test
128+
$ npm test
129129
```
130130

131131
You can watch files and run tests when any changes are detected by using:
132132

133133
```bash
134-
$ yarn test -- -w
134+
$ npm test -- -w
135135
```
136136

137137
### JavaScript Style
@@ -141,7 +141,7 @@ In order to minimize code style differences, we have adopted the [StandardJS][st
141141
**note: you can check compatibility by running tests**
142142

143143
```bash
144-
$ yarn test
144+
$ npm test
145145
```
146146

147147
**note: you may also be able to automatically fix any style issues with the `standard` tool**

0 commit comments

Comments
 (0)