Codex
A modular security scanner with a clean and simple UI. Built with React, FastAPI, Python, PowerShell & Bash.
Development Instructions
Requirements (for development):
- Python 3.10
- NodeJS
- NPM (MacOS) / NVM (Windows)
- Redis (MacOS) / Memurai (Windows)
- Powershell 7
Installation:
- Clone the repository
- In the
backend/api
folder, runpip install pipenv
and thenpipenv install
- In the frontend folder, run
npm install
Running (Windows):
cd backend/api
and runpipenv shell
cd
back to the root folder and runuvicorn backend.main:app --reload --log-config .\backend\log\uvicorn.ini --use-colors
- In another terminal (as admin), repeat step 1 and then run
celery --app=backend.runner.tasks worker --loglevel info -E --pool=threads --without-gossip --without-mingle --without-heartbeat
- In another terminal,
cd frontend
and runnpm start-browser
Building Requirements (for building)
- InstallSimple 3.1
cd
to cloned directory (~codex
) and runpwsh ~codex/dev/Copy-CodexBack.ps1; pwsh /~codex/dev/Copy-CodexAll.ps1
- Run
pwsh ~codex\dev\Build-Codex.ps1
- This will launch the
codex-setup.iss
file. Follow the on-screen prompts to build thecodex-setup.exe
file. - The setup file will be avaliable in
~codex\prod\setup\codex-setup.exe"
which can be installed on any Windows machine.