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
+19-3Lines changed: 19 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,6 +13,22 @@ Environment based configuration using [Dotenv](https://www.npmjs.com/package/dot
13
13
14
14
Integration Testing with [SuperTest](https://github.com/visionmedia/supertest)
15
15
16
+
## Quickstart
17
+
```
18
+
npm install -g yarn
19
+
yarn install
20
+
# install docker https://docs.docker.com/install/
21
+
docker stack deploy -c local-infra.yml infra
22
+
# connect to postgres via postgres:password@localhost:5432
23
+
# create 'seed' user with password 'password'
24
+
# create 'seed' database and set the 'seed' user as the owner
25
+
cp .env.example .env
26
+
yarn run start
27
+
# wait for app to start
28
+
yarn global add sequelize-cli
29
+
sequelize db:seed:all
30
+
```
31
+
16
32
## Environment Setup
17
33
This project uses the [Dotenv](https://www.npmjs.com/package/dotenv) library to load sensitive data such
18
34
as database passwords and client secrets.
@@ -21,10 +37,10 @@ There is a `.env.example` file included at the root of this project as an exampl
21
37
for your project.
22
38
23
39
### RabbitMQ
24
-
Install and run [RabbitMQ](https://www.rabbitmq.com/) with the default settings
40
+
Install and run [RabbitMQ](https://www.rabbitmq.com/) with the default settings (or use the provided local-infra.yml in conjunction with docker-compose/swarm)
25
41
26
42
### Database
27
-
You will need a [PostgreSQL](https://www.postgresql.org) database running on localhost:5432
43
+
You will need a [PostgreSQL](https://www.postgresql.org) database running on localhost:5432 (or use the provided local-infra.yml in conjunction with docker-compose/swarm)
28
44
29
45
The setup of PostgreSQL is beyond the scope of this guide. Please reference the [Install Guides](https://wiki.postgresql.org/wiki/Detailed_installation_guides)
30
46
for help installing PostgreSQL on your machine.
@@ -43,7 +59,7 @@ You can also run the app in debug mode and attach a [Debugger](https://www.jetbr
43
59
Once the app is running and the tables are created, you can seed the database with the sequelize-cli.
0 commit comments