sartography
/
cr-connect-workflow
mirror of https://github.com/sartography/cr-connect-workflow.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
13 Commits 18 Branches 0 Tags 8.3 MiB
Python 98.2%
HTML 1%
Shell 0.7%
Go to file
Aaron Louie 9eeb53b8d0 There is no #3. 2019-11-19 17:54:49 -05:00
api Fixes some typos and syntax errors 2019-11-19 16:13:07 -05:00
model Adds basic Flask, Connexion, and SpiffWorkflow structure 2019-11-19 15:57:46 -05:00
schema Adds basic Flask, Connexion, and SpiffWorkflow structure 2019-11-19 15:57:46 -05:00
static/bpmn Adds basic Flask, Connexion, and SpiffWorkflow structure 2019-11-19 15:57:46 -05:00
workflows Adds basic Flask, Connexion, and SpiffWorkflow structure 2019-11-19 15:57:46 -05:00
.gitignore Adds basic Flask, Connexion, and SpiffWorkflow structure 2019-11-19 15:57:46 -05:00
LICENSE.md Adds basic Flask, Connexion, and SpiffWorkflow structure 2019-11-19 15:57:46 -05:00
Pipfile Fixes broken pipenv files 2019-11-19 16:53:46 -05:00
Pipfile.lock Fixes broken pipenv files 2019-11-19 16:53:46 -05:00
README.md There is no #3. 2019-11-19 17:54:49 -05:00
api.yml Fixes some typos and syntax errors 2019-11-19 16:13:07 -05:00
run.py Enables auto-generated swagger UI for exploring API documentation and testing API. 2019-11-19 17:11:33 -05:00

README.md

CR Connect Workflow Microservice

Development Setup

Tools

These instructions assume you're using these development and tools:

  • IDE: PyCharm Professional Edition
  • Operating System: Ubuntu

Environment Setup

Make sure all of the following are properly installed on your system:

  1. python3 & pip3:
  2. pipenv:

Project Initialization

  1. Clone this repository.
  2. In PyCharm:
    • Go to File > New Project...
    • Click Pure Python (NOT Flask!!)
    • Click the folder icon in the Location field.
    • Select the directory where you cloned this repository and click Ok.
    • Expand the Project Interpreter section.
    • Select the New environment using radio button and choose Pipenv in the dropdown.
    • Under Base interpreter, select Python 3.6
    • In the Pipenv executable field, enter /home/your_username_goes_here/.local/bin/pipenv
    • Click Create
  3. PyCharm should automatically install the necessary packages via pipenv. To add/remove/manage packages, make sure to only use pipenv install (or whatever) via the Terminal within PyCharm. Otherwise, you might corrupt your Pipfile.lock file and spend several hours floundering.