exo/simplex-api
13
0
Fork 0
Code Issues 14 Pull requests Packages Projects 1 Releases Wiki Activity

Updated README.md

Browse source
This commit is contained in:
Roger Garcia 2020-04-08 13:05:22 +02:00
parent 1a36b51266
commit a14fb6bbb6
1 changed files with 12 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -51,10 +51,16 @@ You can start developing with these commands:
You also need a valid database running in your computer.
### Add models to database
As we use FreeRADIUS datasource we should only modify our schema in the database. If you add some models to the system and you want to auto-migrate the schema you must add the models inside `src/migrate.ts`.
### Multiple datasources
We have moved our data (simplex entities) to a postgresql database. Now this project uses two different database systems:
- mariaDB: For radius stuff
- postgreSQL: For all simplex entities.
### Using Docker to provide database
In order to create simplex data structure you should run:
`npm run migrate`
### Using Docker to provide databases
It's a common practice the use of Docker container system to deploy the services needed in the development process. The next tips help you to run the environment using Docker:
- It's necessary to have installed `docker` and `docker-compose`
@ -63,4 +69,6 @@ It's a common practice the use of Docker container system to deploy the services
- `sudo apt install python3-pip; sudo pip install docker-compose`
- Then simply run: `docker-compose up`
By default, the database is populated using `/dump/radius.sql` contents.
By default, the radius database is populated using `/dump/radius.sql` contents.
This method provides both databases.