Reading the repo
Opening the box…
Assembly instructions
Edmartt/
Microservice for handling work orders and when are done send event through Redis streams
Python#docker#docker-compose#openapi#openapi3
Before you start
- Is it free?
- UnclearGitHub found no license file, so check the README before reusing the code.
- Still maintained?
- Looks inactiveLast change 2.0 years ago. Fixes may not come.
- Can I trust it?
- New, little track record0 stars, 3 years old. Look at the code and the owner before running it.
- Difficulty
- Involved
- Time
- 30 min or more
- Stars
- ★ 0
- Activity
- Quiet for 2.0 years
GitHub didn't answer, so this is the saved copy from 15 h ago
Will it work on macOS?
Yes, it runs on macOS
- You'll build it yourself with Python.
- It also needs PostgreSQL, Redis running (Docker handles this).
Start here
Heads-upIt also needs PostgreSQL and Redis.
4 steps on macOS
Then run bash setup.sh. It stops at the first error and is safe to run again. Servers and tests aren't started; it lists them at the end. Read it first.
Clone the repository
Needs Git: xcode-select --install
git clone https://github.com/Edmartt/WorkOrders.git cd WorkOrders
Install the required runtimes
Python 3.x (no version pinned)
brew install python
Start backing services
Needs: PostgreSQL, Redis
brew install --cask docker # Docker Desktop docker compose -f docker-compose.yml up -d
If you see Cannot connect to the Docker daemon: start Docker Desktop (or the Docker service) first.Install dependencies
python -m venv .venv source .venv/bin/activate pip install -r requirements.txt
From the README: Running Development Version With Flask
- Clone the repo:
git clone https://github.com/Edmartt/WorkOrders.git
- Browse into the project directory
cd WorkOrders/
- Create a virtual environment
python -m venv <virtual-environment-name>
- Activate the virtual environment
source <virtual-environment-name>/bin/activate
- Install dependencies
pip3 install -r requirements
- Set the environment variables following the envrc.example file here
source .envrc
Note
Remember to set a .env file for docker-compose and run
docker-compose up -d for creating a postgres instance
- Migrations
We need migrations for our data models
flask db upgrade
- Run with
flask run
Note
For requesting the api docs after running the project just go to /api/docs
Did you get it running?
No reports for macOS yet.
Still stuck? Get a written guide
GitManual AI Agent reads the 3 key files and writes a step-by-step guide for macOS. Once written, it's saved for everyone.