mirror of https://github.com/ctk-hq/ctk
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
42 lines
1.0 KiB
Markdown
42 lines
1.0 KiB
Markdown
# Container ToolKit
|
|
|
|
|
|
|
|
## Local setup and development
|
|
|
|
On a Mac/Linux/Windows you need Docker, Docker Compose installed. Optionally GCC to run make commands for convenience, or just run the commands from the Makefile by hand.
|
|
|
|
To get the tool working locally, just run:
|
|
|
|
```shell script
|
|
make up
|
|
make local_server_init
|
|
make dev_server
|
|
cd services/frontend && npm i && npm run start
|
|
```
|
|
|
|
### Server
|
|
|
|
```bash
|
|
python -m venv .env
|
|
source .env/bin/activate
|
|
python -m pip install -r services/backend/requirements.txt
|
|
python -m pip install black
|
|
|
|
make dev_server
|
|
```
|
|
|
|
... this command will bring up the backend, the database, sync migrations,
|
|
|
|
## Project roadmap
|
|
|
|
- Complete react rewrite.
|
|
- Ongoing improvements and features for docker compose yaml generation.
|
|
- Kubernetes manifest generation.
|
|
- Deployment to user's ECS, K8S, GS accounts.
|
|
|
|
## Docs
|
|
|
|
- https://docs.jsplumbtoolkit.com/community/
|
|
- https://github.com/compose-spec/compose-spec/blob/master/spec.md
|
|
- https://docs.docker.com/compose/compose-file/ |