Skip to content
This repository was archived by the owner on Dec 14, 2023. It is now read-only.

Commit 22fcddb

Browse files
author
Ursula Clarke Everett
committed
Update readme to point to documentation and cp-local-dev repos
1 parent bca11cf commit 22fcddb

File tree

1 file changed

+4
-28
lines changed

1 file changed

+4
-28
lines changed

README.md

Lines changed: 4 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,9 @@
11
# cp-users-service
2-
Community Platform - Users Core Service
32

4-
## Install:
5-
```
6-
npm install
7-
```
3+
## About
84

9-
## Database:
5+
This is the users service, a backend repository of the [CoderDojo Zen Community Platform](https://github.com/CoderDojo/community-platform) project. The service looks after the users section of the API (anything to do with retrieving data/information about users/admins).
106

11-
This service requires it's own PostgreSQL database to run:
12-
13-
- using pgAdmin connect to PostgreSQL database:
14-
- `docker ps` to make sure the PostgreSQL container is running
15-
- use the `boot2docker ip` as the ip address (this is usually 192.168.59.103)
16-
- user: postgres passwd: blank
17-
- create a new database called `cp-users-development`
18-
- next create a new user, right click on 'Login Roles' and select 'New Login Role'
19-
(note: you need to create this new user only if you don't have it already)
20-
- username: 'platform'
21-
- password: 'QdYx3D5y'
22-
- give the user All Role Privileges
23-
24-
## Configuration
25-
26-
Ensure configuration file for the running environment exists and has the correct options. Default environment is development, options read from `config/config.js` - environment overrides in `config/<environment>.env`.
27-
28-
## Run
29-
30-
Start Server:
31-
32-
`./start.sh development ./service.js`
7+
If you want to get set up to make a backend contribution, please see the [cp-local-development repository](https://github.com/CoderDojo/cp-local-development).
338

9+
General documentation is in the [community-platform repository](https://github.com/CoderDojo/community-platform).

0 commit comments

Comments
 (0)