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
{{ message }}
This repository was archived by the owner on Jun 27, 2019. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+11-12Lines changed: 11 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,14 +35,20 @@ Getting up and running is as easy as 1, 2, 3, 4 ... 5.
35
35
$ cd ./API
36
36
$ yarn
37
37
```
38
+
4. Setup database seeder for local development (recommended)
38
39
39
-
4. Setup local mailserver (optional)
40
+
Run
41
+
```sh
42
+
cp config/local.example.json config/local.json
43
+
```
44
+
45
+
5. Setup local mailserver (optional)
40
46
41
47
> **Note:**
42
48
> *You only have to start that mailserver when you want to register, reset your password or test emails in any form, it
43
49
> does not affect the rest of the application.*
44
50
45
-
Copy `config/local.example.json` to `config/local.json` and install the [MailDev](https://github.com/djfarrelly/MailDev)
51
+
Install the [MailDev](https://github.com/djfarrelly/MailDev)
46
52
server to catch all sent emails in a nice web interface.
47
53
48
54
```bash
@@ -57,7 +63,7 @@ Getting up and running is as easy as 1, 2, 3, 4 ... 5.
57
63
You could also insert your smtp credentials into the local.json but that is not recommended as all emails would be sent
58
64
to the given addresses which should not happen in development.
59
65
60
-
5. Start server
66
+
6. Start server
61
67
62
68
Make sure that the `data` folder exists according to the `mongod --dbpath` in `package.json` to write the data into, then start the server:
63
69
```bash
@@ -81,7 +87,7 @@ Getting up and running is as easy as 1, 2, 3, 4 ... 5.
81
87
If you did it right it will seed some fake data for you and downloads some images and avatar for faster development.
82
88
Now you should be able to list some post at [http://localhost:3030/contributions](http://localhost:3030/contributions)
83
89
84
-
6. Setup and Start Thumbnail Service (optional)
90
+
7. Setup and Start Thumbnail Service (optional)
85
91
86
92
We are using [Thumbor](https://github.com/thumbor/thumbor) as a Thumbnail Microservice.
87
93
You can install it locally if you like but this is totally optional.
@@ -97,14 +103,7 @@ Getting up and running is as easy as 1, 2, 3, 4 ... 5.
97
103
98
104
If you need to configure anything you can do so inside the `config/local.json` file. For that the `config/local.example.json` will contain always a minimal setup to get it working.
99
105
100
-
If, f.ex., you want to change listen address, port or URL, you can do so. Entries in the `config/local.json` will override entries in the `config/default.json`.
101
-
102
-
**Note on the seeder configuration**
103
-
The seeder configuration has two properties:
104
-
- **dropDatabase:** drop the whole database on (re)start.
105
-
- **runOnInit:** run the seeder always on server (re)start (when database is empty).
106
-
107
-
> **Note** *You can switch the `dropDatabase` entry after seeding and it will persist the seeded data.*
106
+
E.g. if you want to change listen address, port or URL, you can do so. Entries in the `config/local.json` will override entries in the `config/default.json`.
0 commit comments