This tutorial will help you set up a full Development environment with all components of the
git clone [email protected]:isabl-io/api.gitcd api
Create a superuser with username and password set to
admin (we will need it later):
docker-compose run --rm django python manage.py createsuperuser --email [email protected] --username admin
Now you can login in the frontend at http://localhost:8000 (there won't be much to see). An easy way to create objects is to run the client tests.
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
git clone [email protected]:isabl-io/cli.gitcd cli
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.
git clone [email protected]:isabl-io/web.gitcd web
brew install yarn --without-node
Start the react development server:
FRONTEND_URL=localhost:8080 before running
docker-compose up in the api repository, note that the port may vary.
Simply create a PR in github:
git clone [email protected]:isabl-io/docs.git
Create a branch for local development and get ready to make changes locally:
git pullgit checkout -b name-of-your-bugfix-or-feature
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
Create a test in:
Submit a pull request through the GitHub website.
Python Projects are formatted with black. Is required for
apps, simply run:
pip install black && black .
web is formatted following the Vue style guide. For this one, simply run:
Following the semantic versioning guidelines and update the
VERSION file before creating a PR, for instance:
echo v0.1.0 > isabl_api/VERSIONgit add isabl_api/VERSIONgit 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:
type of change
changes to documentation
formatting no code change
refactoring production code
adding/editing test logic
no production code change
bump to new version