In this tutorial, you will get to run the Misakey's stack locally in 5 min. After that you will be able to start hacking around.
For production install, please check the dedicated guide.
- Python3 (with Pip)
- Docker compose
We grouped all the tools required to run the app locally in a project called test and run.
Clone the repository with
git clone firstname.lastname@example.org:misakey/test-and-run.git.
Install the CLI:
- Go to the
- Make sure you have
pipfor Python 3
pip install -e .
misacli CLI must be used in the root directory of the project.
Run the command
misacli init and follow the instructions.
The others commands are described in the CLI help (
Example: To run the whole application, run
misacli run app.
Open your web browser and go to https://app.misakey.com.local.
You will have to accept self-signed certificates (3 times): we decided to use SSL even in local development environement to be closer to a real-world environment.
Then you can play with the demo application: using the auth, creating data channels and chatting through them…
From there, you can create your own app using the SSO and the other bricks of the system.
You can find a more complete documentation of the APIs and the usage of the stack in dedicated guides.