Comment on page
⏱ tutorial time: 20 minutes
This tutorial will help you set up a full Development environment with all components of the
📘 Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
isablcould always use more documentation, whether as part of the README, in doc-strings, or even on the web in blog posts articles, and such. Also, bet you've read the Zen Of Python.
- 2.Build containers:docker-compose build
Create a superuser with username and password set to
admin(we will need it later):
Since tests were run inside a container, we need to combine the coverages to see the html report:
alias opencov="mv .coverage .coverage.tmp && coverage combine && coverage html && open htmlcov/index.html"
pip install coverage && opencov
- 2.Install with pip, it is strongly recommended to install in a virtual environment:pip install -r requirements.txt
Note: if your changes depend on a particular branch of Isabl API, make sure both Isabl CLI and Isabl API branches are called the same so that the travis configuration can pick that up.
- 2.Install yarn:brew install yarn --without-node
- 3.Install dependencies:yarn install
- 4.Start the react development server:yarn serveImportant! export
docker-compose upin the api repository, note that the port may vary.
- 1.Create a branch for local development and get ready to make changes locally:git pullgit checkout -b name-of-your-bugfix-or-feature
- 2.Commit your changes and push your branch to GitHub (see the emoji reference):git add .git config commit.template .gitmessagegit commit -m ":emoji: your short and nice description"git push origin name-of-your-bugfix-or-feature
- 3.Create a test in:tests/
- 4.Submit a pull request through the GitHub website.
pip install black && black .
echo v0.1.0 > isabl_api/VERSION
git add isabl_api/VERSION
git commit -m ":gem: bump to version 0.1.0"
We use emojis to quickly categorize commits and pull requests. These are some common type of changes we use but feel free to ignore the conventions:
Tip: To insert an emoji in mac type
control+cmd+space. Alternative, type the emoji's name within two semicolons (e.g.