doc: updated with reference to doc in wiki
This commit is contained in:
parent
983eab6ef3
commit
3a859bcdc3
69
README.md
69
README.md
@ -8,24 +8,32 @@ These instructions will get you a copy of the project up and running on your loc
|
||||
|
||||
### Prerequisites
|
||||
|
||||
To install SiB App, you'll need to have:
|
||||
To install SiB App, you'll need:
|
||||
|
||||
- Python3 & Pip
|
||||
- NodeJS & NPM
|
||||
- A Prosody Server
|
||||
- (Optional) A SMTP Server
|
||||
* A SIB server with the appropriate modules
|
||||
* A Prosody Server
|
||||
* A SMTP Server (optional)
|
||||
* NodeJS on your machine
|
||||
|
||||
### Installing
|
||||
Before diving in you have to check your SIB server supports the following LDP packages:
|
||||
|
||||
[Install a server and a client application](https://git.happy-dev.fr/startinblox/devops/doc/wikis/deploy_a_sib_application)
|
||||
* djangoldp_project: 0.1.12
|
||||
* djangoldp_uploader: 0.0.5
|
||||
* djangoldp_circle: 0.1.9
|
||||
* djangoldp_notification: 0.1.4
|
||||
* djangoldp_account: 0.2.12
|
||||
* djangoldp_skill: 0.1.1
|
||||
* djangoldp_joboffer: 0.1.1
|
||||
* djangoldp_conversation: 0.2.1
|
||||
* djangoldp_profile: 0.1.4
|
||||
* djangoldp_invoice: 0.1.0
|
||||
* oidc_provider: 'git+https://github.com/jblemee/django-oidc-provider.git@develop'
|
||||
|
||||
Or build the docker images and run it:
|
||||
```
|
||||
$ docker build -t sibapp docker/
|
||||
$ docker run --rm -p 127.0.0.1:8000:8000 -it sibapp
|
||||
```
|
||||
Those packages are given with the last stable version tested.
|
||||
|
||||
## FIXME
|
||||
Refer to the [documentation to install a SIB server](https://git.happy-dev.fr/startinblox/devops/doc/wikis/y_a_sib_application) with this configuration.
|
||||
|
||||
## Configure your SIB server
|
||||
|
||||
Create a Client ID for Prosody & Client
|
||||
|
||||
@ -46,26 +54,37 @@ Create a Client ID for Prosody & Client
|
||||
```
|
||||
- Keep the `6-digits` newly create `Client ID` somewhere
|
||||
|
||||
Configure `config.json`:
|
||||
## Build the application
|
||||
|
||||
On the newly created `./src/config.json` change the `dev` configuration like this:
|
||||
In order to find your server(s) the client application needs to be assembled with the proper configuration.
|
||||
|
||||
Get the code of the SIB app on your machine:
|
||||
```
|
||||
"dev": {
|
||||
"sdn": "http://api.myserver.com", # Or localhost:8000
|
||||
"cdn": "https://cdn.happy-dev.fr",
|
||||
"xmpp": "https://prosody.myserver.com/http-bind/",
|
||||
"client_id": "000000" # <- Here goes your previously created Client ID
|
||||
},
|
||||
$ git clone ...
|
||||
```
|
||||
|
||||
Then create a `config.json` with all the server hosting the capabilities the SIB App requires (for convienence a `config.sample.json` exsits):
|
||||
```
|
||||
{
|
||||
"sdn": "http://api.myserver.com", # Or localhost:8000
|
||||
"cdn": "https://cdn.happy-dev.fr",
|
||||
"xmpp": "https://prosody.myserver.com/http-bind/",
|
||||
"client_id": "000000" # <- Here goes your previously created Client ID
|
||||
},
|
||||
```
|
||||
FIXME: complete the file and explain details
|
||||
|
||||
Then build your new SIB App:
|
||||
```
|
||||
$ npm run build
|
||||
```
|
||||
|
||||
The application bundle is in the `dist` folder, ready to be deployed everywhere as a static file.
|
||||
|
||||
## Built With
|
||||
|
||||
* [Sib-Core](https://git.happy-dev.fr/startinblox/framework/sib-core/) - An awesome new framework!
|
||||
|
||||
### Architecture
|
||||
|
||||
Some general schema of the existing StartinBlox applications architecture can be found [here](https://docs.google.com/presentation/d/1iCRGaJpFvZjhjIUnpsn6lRTJJ31ES6n94BNkJygzUwM/edit?usp=sharing).
|
||||
|
||||
<!---
|
||||
## Contributing
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user