Skip to content
This repository was archived by the owner on Jun 27, 2019. It is now read-only.

Commit 36069fd

Browse files
committed
Update README
Remove obvious documentation
1 parent 24eec29 commit 36069fd

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

README.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,20 @@ Getting up and running is as easy as 1, 2, 3, 4 ... 5.
3535
$ cd ./API
3636
$ yarn
3737
```
38+
4. Setup database seeder for local development (recommended)
3839

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)
4046

4147
> **Note:**
4248
> *You only have to start that mailserver when you want to register, reset your password or test emails in any form, it
4349
> does not affect the rest of the application.*
4450
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)
4652
server to catch all sent emails in a nice web interface.
4753

4854
``` bash
@@ -57,7 +63,7 @@ Getting up and running is as easy as 1, 2, 3, 4 ... 5.
5763
You could also insert your smtp credentials into the local.json but that is not recommended as all emails would be sent
5864
to the given addresses which should not happen in development.
5965

60-
5. Start server
66+
6. Start server
6167

6268
Make sure that the `data` folder exists according to the `mongod --dbpath` in `package.json` to write the data into, then start the server:
6369
``` bash
@@ -81,7 +87,7 @@ Getting up and running is as easy as 1, 2, 3, 4 ... 5.
8187
If you did it right it will seed some fake data for you and downloads some images and avatar for faster development.
8288
Now you should be able to list some post at [http://localhost:3030/contributions](http://localhost:3030/contributions)
8389
84-
6. Setup and Start Thumbnail Service (optional)
90+
7. Setup and Start Thumbnail Service (optional)
8591
8692
We are using [Thumbor](https://github.com/thumbor/thumbor) as a Thumbnail Microservice.
8793
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.
97103
98104
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.
99105
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`.
108107
109108
## Testing
110109

0 commit comments

Comments
 (0)