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
<ahref="https://creativecommons.org/licenses/by-nc-sa/4.0/"><img src="https://img.shields.io/badge/license-CC%20BY--NC--SA%204.0-green.svg" "Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)" /></a>
8
9
</p>
9
10
10
-
# HumanConnection API
11
+
# Human-Connection API
11
12
12
-
The API for a better world. More information under [humanconnection.org](https://humanconnection.org)
13
+
The API for a better world. More information under [human-connection.org](https://human-connection.org)
13
14
14
-
> **Note:** This is only the API part of HumanConnection, you can also checkout the Frontend which uses this API.
15
+
> **Note:** This is only the API part of Human-Connection, you have to also checkout the [Frontend](https://github.com/HumanConnection/HC-Frontend) which uses this API.
15
16
16
17
## Framework
17
18
18
19
This project uses [Feathers](http://feathersjs.com). An open source web framework for building modern real-time applications.
19
20
20
21
## Getting Started
21
22
23
+
> we recommand to install the project locally for the best development ease and performance
24
+
22
25
Getting up and running is as easy as 1, 2, 3, 4 ... 5.
23
26
24
27
1. Make sure you have [NodeJS](https://nodejs.org/), [yarn](https://yarnpkg.com), [mongoDB](https://www.mongodb.com/download-center#community) installed.
@@ -36,7 +39,7 @@ Getting up and running is as easy as 1, 2, 3, 4 ... 5.
36
39
37
40
4. Setup local mailserver (optional)
38
41
39
-
> **NOTE:**
42
+
> **Note:**
40
43
> *You only have to start that mailserver when you want to register, reset your password or test emails in any form, it
41
44
> does not affect the rest of the application.*
42
45
@@ -105,7 +108,7 @@ The seeder configuration has two properties:
105
108
106
109
Simply run `yarn test` and all your tests in the `test/` directory will be run.
107
110
108
-
> **NOTE:**
111
+
> **Note:**
109
112
> *At the moment there are some issues with linting while testing, but you can run the tests also with mocha run*
0 commit comments