{"id":31565753,"url":"https://github.com/correlaid/engage-2","last_synced_at":"2025-10-05T07:17:16.245Z","repository":{"id":182620005,"uuid":"413080013","full_name":"CorrelAid/engage-2","owner":"CorrelAid","description":null,"archived":false,"fork":false,"pushed_at":"2023-11-01T13:45:39.000Z","size":696,"stargazers_count":0,"open_issues_count":14,"forks_count":0,"subscribers_count":1,"default_branch":"development","last_synced_at":"2023-11-02T11:39:20.662Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CorrelAid.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2021-10-03T13:05:49.000Z","updated_at":"2023-11-02T11:39:20.662Z","dependencies_parsed_at":"2023-10-10T13:47:17.151Z","dependency_job_id":"811beb33-e77c-41e9-9e82-628f1b87b300","html_url":"https://github.com/CorrelAid/engage-2","commit_stats":null,"previous_names":["correlaid/engage-2"],"tags_count":0,"template":null,"template_full_name":null,"purl":"pkg:github/CorrelAid/engage-2","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CorrelAid%2Fengage-2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CorrelAid%2Fengage-2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CorrelAid%2Fengage-2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CorrelAid%2Fengage-2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CorrelAid","download_url":"https://codeload.github.com/CorrelAid/engage-2/tar.gz/refs/heads/development","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CorrelAid%2Fengage-2/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278421837,"owners_count":25984075,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-05T02:00:06.059Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-10-05T07:17:15.009Z","updated_at":"2025-10-05T07:17:16.238Z","avatar_url":"https://github.com/CorrelAid.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CorrelAid Engage\n\nCorrelAid engage is a tool intended to help with the management of projects that\nare often done with partner organizations. The tools aims to help with the\norganization of the whole project life cycle. It is currently\nin development and not yet ready for production use.\n\nThe main entities in the system tracks are:\n\n- Projects\n- Partner organizations\n- Project members\n\nIn addition the tool aims to offer two different levels of access:\n\n- Admins: Can create and edit all entities\n- Team Admins: Can create and edit all entities for their team\n\n## Project structure\n\nThe project is split into a frontend and a backend. The frontend is a Vue.js app and the backend is a python app using FastAPI. Storage is done in a Postgres database.\n\nTo see how to setup the development environment for the frontend and backend see the respective READMEs in the `frontend` and `backend` folders.\n\n## Selected Makefile commands\n\nIn this section we only aim to provide a short overview of the most important commands. For a full list of commands see the `Makefile`.\n\n- `make up`: Starts the backend development environment in docker\n\n## Dev Deployment\n\nTo make a dev deployment of the backend you need to\n\n1.  Log into the dev server instance\n\n1.  Clone the repository\n\n1.  Go to the project folder and checkout the branch you want to deploy\n\n1.  Make a copy of the `.env` file\n\n        cp .env .env.dev\n\n1.  Update the `.env` file with the desired values. Additionally the following\n    variables for the database need need to be set:\n\n        POSTGRES_USER=\n        POSTGRES_DB=\n        POSTGRES_PASSWORD=\n\n    Their values have to be the same as the ones set for the `ENAGE_BACKEND_DATABASE`\n    environment variables in the same file.\n\n1.  Set up caddy\n\n        TBD\n\n1.  Run the following make command.\n\n        make build-and-start-dev-frontend-backend\n        make start-dev-database\n\n    This will build and start the frontend and backend containers. The backend will run on port `8000` and the frontend on port `8080`.\n\n1.  To apply migrations and create database users execute the following commands inside he backend container.\n\n        python -m alembic upgrade head\n        python cli.py adduser\n\n    Or equivalently outside of a container\n\n        docker exec engage-api python -m alembic upgrade head\n        docker exec engage-api run python cli.py adduser\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcorrelaid%2Fengage-2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcorrelaid%2Fengage-2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcorrelaid%2Fengage-2/lists"}