You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,7 +42,7 @@ The docker-compose setup is configured to reboot the bot when any local file cha
42
42
Leonel uses MongoDB to store specific information about users, you can create the user accounts by running:
43
43
44
44
```bash
45
-
$ docker-compose run bot yarn db:seed
45
+
$ docker-compose run bot npm run db:seed
46
46
```
47
47
48
48
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
52
52
You can run `ava` tests in a container, by running:
53
53
54
54
```bash
55
-
$ docker-compose run bot yarntest
55
+
$ docker-compose run bot npmtest
56
56
```
57
57
58
58
If you want for tests to watch your files, you can run:
59
59
60
60
```bash
61
-
$ docker-compose run bot yarntest -- -w
61
+
$ docker-compose run bot npmtest -- -w
62
62
```
63
63
64
64
If you want to modify the `DEBUG` env var, you can run:
65
65
66
66
```bash
67
-
$ docker-compose run -e DEBUG="" bot yarntest -- -w
67
+
$ docker-compose run -e DEBUG="" bot npmtest -- -w
68
68
```
69
69
70
70
#### Shutting Down
@@ -82,20 +82,20 @@ $ docker-compose down
82
82
All environment variables in [example env file][env] should be set before running Leonel.
83
83
84
84
Other requirements:
85
-
-Yarn
86
-
- NodeJS 7.7.x
85
+
-Npm
86
+
- NodeJS 12.10.x
87
87
- MongoDB
88
88
89
89
Install dependencies:
90
90
91
91
```bash
92
-
$ yarn
92
+
$ npm install
93
93
```
94
94
95
95
Start leonel:
96
96
97
97
```bash
98
-
$ yarn start
98
+
$ npm start
99
99
```
100
100
101
101
Things are looking good if the console prints something like:
@@ -107,14 +107,14 @@ Things are looking good if the console prints something like:
107
107
bot:main Estamos coneptados al Eslá
108
108
```
109
109
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.
111
111
112
112
#### Seed users
113
113
114
114
Leonel uses MongoDB to store specific information about users, you can create the user accounts by running:
115
115
116
116
```bash
117
-
$ yarn db:seed
117
+
$ npm run db:seed
118
118
```
119
119
120
120
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
125
125
We use ava for unit and integration testing, you can run tests by typing:
126
126
127
127
```bash
128
-
$ yarntest
128
+
$ npmtest
129
129
```
130
130
131
131
You can watch files and run tests when any changes are detected by using:
132
132
133
133
```bash
134
-
$ yarntest -- -w
134
+
$ npmtest -- -w
135
135
```
136
136
137
137
### JavaScript Style
@@ -141,7 +141,7 @@ In order to minimize code style differences, we have adopted the [StandardJS][st
141
141
**note: you can check compatibility by running tests**
142
142
143
143
```bash
144
-
$ yarntest
144
+
$ npmtest
145
145
```
146
146
147
147
**note: you may also be able to automatically fix any style issues with the `standard` tool**
0 commit comments