requirements/ src/
- domain/
- config/
- interface/
- infrastructure/
Make sure you have permissions for all files
$ chmod +x ./feature.sh (...)
To create a new feature-branch:
$ ./feature.sh "feature-name"
To commit in the current branch:
$ ./commit.sh "commit-message"
To make a hot fix (branch master only):
$ ./hotfix "hotfix-name"
To push in the current branch:
$ ./push
To synchronize the flow of new commits in order to avoid possible conflicts:
$ ./sincflow
Using Travis, for now, just have continuos integration
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Be sure, have installed:
- Python3.5
- Pip
- Redis
You will need to install in your machine the following packages:
- redis
- flask-restful
- pylint
- pytest
- pycodestyle
- coverage
Installation via pip:
$ pip install -r requirements/develop.txt
If you'd like up and running using Docker, please, be sure you have:
- Docker
- Docker Compose
Up and Running via Docker Compose:
$ docker-compose up
PYTHONPATH - It's the path to source app (src/)
REDIS_DATABASE - It's the database created on Redis
REDIS_HOST - It's the host running redis-server
REDIS_PASSWORD - It's password to connect to Redis, if you have one.
REDIS_PORT - Specifies the port for the connection.
HOST_API - It's host running API
TTL_REQUEST_API - Specifies the time that API must denied same body and method by requestconnection.
A step by step series of examples that tell you how to get a development env running
Be sure you have exported all env vars
$ pip install -r requirements/develop.txt
$ python src/core.py
Or, you can easily use Docker Compose
$ docker-compose up
To execute the tests, run:
$ pytest src/tests
Be sure, have installed all libraries using:
$ pip install -r requirements/develop.txt
It's also necessary to export the environment variables described above.
To run lint for your code, execute:
$ pylint src/ tests/
$curl -XPOST http://localhost:5000/v1/products -d '[{"name": "alane", "id": "1"}]'
TODO