opencal/local-dev
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Development environment based on docker-compose for OpenCal.
20 commits 2 branches 0 tags 62 KiB
Find a file
Exact
Anton Dachauer 0170a38647 add docs repository to local-dev
2025-09-11 12:21:14 +02:00
.github/workflows add shellcheck 2025-06-09 15:07:25 +02:00
data Setup local dev environment with docker compose 2025-06-09 15:00:44 +02:00
.editorconfig Setup local dev environment with docker compose 2025-06-09 15:00:44 +02:00
.env.dist use single backend container without extra nginx 2025-09-05 16:53:34 +02:00
.gitignore Fix radicale 2025-07-30 13:21:57 +02:00
.gitlab-ci.yml setup script for auto-setup the local-dev environment 2025-07-07 18:18:40 +02:00
docker-compose.yml add docs repository to local-dev 2025-09-11 12:21:14 +02:00
generate-ics.sh Fix radicale 2025-07-30 13:21:57 +02:00
LICENSE initial commit 2025-06-09 14:08:19 +02:00
Makefile Fix some make commands 2025-06-12 17:49:52 +02:00
README.md add docs repository to local-dev 2025-09-11 12:21:14 +02:00
setup.sh add docs repository to local-dev 2025-09-11 12:21:14 +02:00

README.md

OpenCal - local development environment

This repository is created for local development of OpenCal, especially for the following repositories:

Getting started

  1. Create a directory for all repositories:
mkdir ~/your-projects/opencal
cd ~/your-projects/opencal
  1. Pull this repository
git clone git@git.var-lab.com:opencal/opencal-dev.git

It should be placed in the folder ~/your-projects/opencal/local-dev.

If you prefer not to perform the following steps manually, you can run the setup script, which will handle it for you:

./setup.sh
  1. Pull the repository:
git clone git@git.var-lab.com:opencal/backend.git ../backend
git clone git@git.var-lab.com:opencal/web-frontend.git ../web-frontend
git clone git@git.var-lab.com:opencal/documentation.git ../documentation

It should be placed in the folder ~/your-projects/opencal/<repository>.

~/your-projects/opencal
|-- /local-dev
|-- /backend
|-- /web-frontend
|-- /documentation
  1. Create .env-file

You can copy the .env.dist file, it contains a basic configuration:

cp .env.dist .env
  1. Build the docker images
make build
# or
docker compose build
  1. Install the dependencies outside the containers
make install
# or
docker compose run --entrypoint="composer" php_backend install
docker compose run --entrypoint="npm" frontend install
  1. Start the docker containers
make up
# or 
docker compose up -d

OpenCal is licensed under the GNU AGPLv3 License.

Created by var-lab IT GmbH and contributors.