Adapted Sib App for ETUC & more flexible way to handle optional components

This commit is contained in:
Jean-Baptiste Pasquier
2020-02-03 14:39:14 +01:00
parent d37796f86f
commit 7eff652d5d
21 changed files with 171 additions and 154 deletions

View File

@ -10,20 +10,18 @@ These instructions will get you a copy of the project up and running on your loc
To install SiB App, you'll need:
* A SIB server with the appropriate modules
* A SIB server (djangoldp>=0.6.32) with the appropriate modules
* A Prosody Server (with [appropriate modules](https://git.happy-dev.fr/startinblox/prosody/custom-prosody-modules/)
* A SMTP Server (optional)
* NodeJS on your machine
Before diving in you have to check your SIB server supports the following LDP packages:
* djangoldp_account: 0.2.14
* djangoldp_circle: 0.1.15
* djangoldp_joboffer: 0.1.1
* djangoldp_notification: 0.1.4
* djangoldp_account: 0.2.24
* djangoldp_circle: 0.1.22
* djangoldp_notification: 0.1.7
* djangoldp_profile: 0.1.4
* djangoldp_project: 0.1.12
* djangoldp_skill: 0.1.1
* djangoldp_project: 0.1.26
* oidc_provider: 'git+https://github.com/jblemee/django-oidc-provider.git@develop'
Those packages are given with the last stable version tested.
@ -40,16 +38,17 @@ Get the code of the SIB app on your machine:
git clone ...
```
Then create a `config.json` with all the the capabilities the SIB App requires. Which are:
Then create a `config.json` based on your needs. [The documentation](https://git.happy-dev.fr/startinblox/devops/doc/wikis/build_sib_application) explains the details of this file but for convienence a `config.sample.json` exists in the source.
* circles
* groups
* joboffers
* projects
* skills
* users
Current Sib App capabilities:
[The documentation](https://git.happy-dev.fr/startinblox/devops/doc/wikis/build_sib_application) explains the details of this file but for convienence a `config.sample.json` exists in the source.
| Component | Required server packages | Required endpoints |
| - | - | - |
| Base | `djangoldp_account`, `djangoldp_profile`, `djangoldp_notification`, `oidc_provider` | `users` |
| Circles | `djangoldp_circle` | `circles` |
| Projects | `djangoldp_project` | `projects`, `customers` |
Federated Sib App needs to use `config.sample.federated.json` example.
Then build your new SIB App:
@ -70,19 +69,3 @@ npm run watch
## Built With
* [Sib-Core](https://git.happy-dev.fr/startinblox/framework/sib-core/) - An awesome new framework!
<!---
## Contributing
We may add a `CONTRIBUTING.md`
## License
We may add a `LICENSE.md`
## Acknowledgments
* Maybe some thanks too
* Inspiration
* etc
--->