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
+8-10Lines changed: 8 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,6 +36,12 @@ Here you can take a look at the database architecture scheme :
36
36
37
37
> Reminder : there is no `password` field because we use LDAP for authentication.
38
38
39
+
## Why using LDAP authentication ?
40
+
41
+
LDAP services are used in a lot of companies and institutions around the world to manage their user accounts and rights in a central place.
42
+
43
+
With this boilerplate, you will be able to develop corporate-ready services AND avoid yourself the troubles of developing registration / password forgotten / change password / profile update code.
44
+
39
45
## Getting started (development)
40
46
41
47
The API is made to run with an LDAP server for managing users. Whether use the provided Docker LDAP server or remove the conf. in [`docker-compose.yml`](./docker-compose.yml) and use your own LDAP server.
@@ -54,7 +60,7 @@ This section will explain to you how to run this project and set-up the LDAP ser
54
60
55
61
2. Change the database/LDAP passwords and keys in `.env`
56
62
57
-
You can now run :
63
+
Then run :
58
64
59
65
```bash
60
66
docker-compose up ldap phpldapadmin database adminer -d
@@ -93,19 +99,11 @@ docker-compose up --build -d api
93
99
94
100
:clock9: NPM's initial install may take quite a lot of time
95
101
96
-
Start the app :
97
-
98
102
```bash
99
103
# Expect several minutes for first launch (npm install)
100
104
docker-compose up --build -d app
101
105
```
102
106
103
-
You can now enjoy the app on [`http://localhost:8080`](http://localhost:8080)
107
+
Enjoy the app on [`http://localhost:8080`](http://localhost:8080)
104
108
105
109
> :information_source: If you want to add a NPM package, just stop & re-launch `docker-compose up app`.
106
-
107
-
## Why using LDAP authentication ?
108
-
109
-
LDAP services are used in a lot of companies and institutions around the world to manage their user accounts and rights in a central place.
110
-
111
-
With this boilerplate, you will be able to develop corporate-ready services AND avoid yourself the troubles of developing registration / password forgotten / change password / profile update code.
0 commit comments