A CRM For Derelicts.
Be sure to use the same version of the code as the version of the docs you're reading. You probably want the latest tagged version, but the default Git version is the main branch:
# clone the repository
$ git clone https://github.com/hoytnix/boundless-crm
$ cd boundless-crm
# checkout the correct version
$ git tag # shows the tagged versions
$ git checkout latest-tag-found-above
Create a virtualenv and activate it:
$ python3 -m venv .venv
$ . .venv/bin/activate
Or on Windows cmd:
$ py -3 -m venv .venv
$ .venv\Scripts\activate.bat
Install Flaskr:
$ pip install -e .
Or if you are using the main branch, install Flask from source before installing Flaskr:
$ pip install -e ../..
$ pip install -e .
$ flask --app yuli init-db
$ flask --app yuli import-csv -f /my/path/to/csv
$ chmod +x restart
$ ./restart
Open http://127.0.0.1:5000 in a browser.
$ pip install '.[test]'
$ pytest
Run with coverage report:
$ coverage run -m pytest
$ coverage report
$ coverage html # open htmlcov/index.html in a browser
Boundless CRM is an Alpha application!
With that being said, thanks for your interest!
You may reach out to Michael Hoyt for questions about collaborating:
📧: michael [d0t] hoyt [@t] fatfirecake [d0t] com
☎: +1 (989) 217 - HEMP (4367)
Boundless CRM uses Eruda for debugging. Eruda
is a mobile browser inspection console. If you are working from a phone
or tablet instead of a desktop you can reach the console by appending
?eruda=true to the end of any URL.
Example Link (/leads?eruda=true)
The gear icon will appear in the bottom right corner of the screen once this parameter is input into the URL — if you tap that icon it'll pull up the inspection console.
Happy debugging!~
Boundless CRM adheres to the principles of style as defined by PEP 8 - Syle Guide For Python Code.
Eventally we will deploy Flake8 to the version management toolbox and styling will be mostly automated.
In the meantime, please familiarize yourself with PEP 8 and adhere to its principles.