Elgato_dark/docs
1
0
Fork 0
mirror of https://github.com/suitenumerique/docs synced 2026-04-21 13:37:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8
docs/Makefile

466 lines
15 KiB
Makefile
Raw Normal View History

✨(project) first proof of concept printing pdf from markdown This is a boilerplate inspired from https://github.com/openfun/joanie
2024-01-09 14:30:36 +00:00
# /!\ /!\ /!\ /!\ /!\ /!\ /!\ DISCLAIMER /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\
#
# This Makefile is only meant to be used for DEVELOPMENT purpose as we are
# changing the user id that will run in the container.
#
# PLEASE DO NOT USE IT FOR YOUR CI/PRODUCTION/WHATEVER...
#
# /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\
#
# Note to developers:
#
# While editing this file, please respect the following statements:
#
# 1. Every variable should be defined in the ad hoc VARIABLES section with a
# relevant subsection
# 2. Every new rule should be defined in the ad hoc RULES section with a
# relevant subsection depending on the targeted service
# 3. Rules should be sorted alphabetically within their section
# 4. When a rule has multiple dependencies, you should:
# - duplicate the rule name to add the help string (if required)
# - write one dependency per line to increase readability and diffs
# 5. .PHONY rule statement should be written after the corresponding rule
# ==============================================================================
# VARIABLES
BOLD := \033[1m
RESET := \033[0m
GREEN := \033[1;32m
# -- Database
DB_HOST = postgresql
DB_PORT = 5432
# -- Docker
# Get the current user ID to use for docker run and docker exec commands
🐛(minio) fix user permission error with Minio and Windows With Minio Docker and Windows, the user ID needs to be set to `0:0` to avoid permission issues. This change ensures that the Minio container runs with root privileges on Windows, which is necessary for proper file access and management.
2025-08-07 10:37:00 +00:00
ifeq ($(OS),Windows_NT)
DOCKER_USER := 0:0 # run containers as root on Windows
else
DOCKER_UID := $(shell id -u)
DOCKER_GID := $(shell id -g)
DOCKER_USER := $(DOCKER_UID):$(DOCKER_GID)
endif
✨(project) first proof of concept printing pdf from markdown This is a boilerplate inspired from https://github.com/openfun/joanie
2024-01-09 14:30:36 +00:00
COMPOSE = DOCKER_USER=$(DOCKER_USER) docker compose
🧑‍💻(docker) create a e2e compose configuration We want to run the e2e tests using the frontend and y-provider production images. We created a dedicated compose file adding just missing services. These services are built in the CI.
2025-06-13 08:19:27 +00:00
COMPOSE_E2E = DOCKER_USER=$(DOCKER_USER) docker compose -f compose.yml -f compose-e2e.yml
✨(project) first proof of concept printing pdf from markdown This is a boilerplate inspired from https://github.com/openfun/joanie
2024-01-09 14:30:36 +00:00
COMPOSE_EXEC = $(COMPOSE) exec
COMPOSE_EXEC_APP = $(COMPOSE_EXEC) app-dev
COMPOSE_RUN = $(COMPOSE) run --rm
COMPOSE_RUN_APP = $(COMPOSE_RUN) app-dev
COMPOSE_RUN_CROWDIN = $(COMPOSE_RUN) crowdin crowdin
# -- Backend
MANAGE = $(COMPOSE_RUN_APP) python manage.py
🐛(makefile) Windows compatibility fix for Docker volume mounting On Windows systems, Docker volume paths starting with a single / can be interpreted incorrectly by the Docker daemon. The double slash (//) helps Docker on Windows properly interpret the path as an absolute path within the container, ensuring that the working directory is correctly set when running mail-related yarn commands.
2025-08-04 11:48:06 +00:00
MAIL_YARN = $(COMPOSE_RUN) -w //app/src/mail node yarn
✨(project) first proof of concept printing pdf from markdown This is a boilerplate inspired from https://github.com/openfun/joanie
2024-01-09 14:30:36 +00:00
🔧(project) add frontend cmd to Makefile add frontend cmd to Makefile.
2024-04-03 10:33:36 +00:00
# -- Frontend
PATH_FRONT = ./src/frontend
PATH_FRONT_IMPRESS = $(PATH_FRONT)/apps/impress
✨(project) first proof of concept printing pdf from markdown This is a boilerplate inspired from https://github.com/openfun/joanie
2024-01-09 14:30:36 +00:00
# ==============================================================================
# RULES
default: help
data/media:
@mkdir -p data/media
data/static:
@mkdir -p data/static
# -- Project
🔧(project) change env.d system by using local files We had lot of problems with the previous env.d system. Users were often confused by the need to change the env.d files manually, leading to issues when using the project locally. This commit introduces a new system that uses .env.local files, which are automatically created and can be modified by users without affecting the original env.d files. This should simplify the development process and reduce confusion by removing the need to manually edit env.d files.
2025-07-18 11:23:56 +00:00
create-env-local-files: ## create env.local files in env.d/development
create-env-local-files:
@touch env.d/development/crowdin.local
@touch env.d/development/common.local
@touch env.d/development/postgresql.local
@touch env.d/development/kc_postgresql.local
.PHONY: create-env-local-files
💚(CI) add frontend jobs Add the frontend jobs to the CI pipeline.
2024-04-03 11:54:11 +00:00
Integrate Find (#1834) ## Purpose integrate Find to Docs ## Proposal - [x] ✨ add a `useSeachDocs` hook in charged of calling the search endpoint. - [x] ✨ add a optional `path` param to the `search` route. This param represents the parent document path in case of a sub-documents (descendants) search. - [x] ⚡️return Indexer results directly without DB calls to retrieve the Document objects. All informations necessary for display are indexed in Find. We can skip the DB calls and improve performance. - [x] ♻️ refactor react `DocSearchContent` components. `DocSearchContent` and `DocSearchSubContent` are now merged a unique component handling all search scenarios and relying on the unique `search` route. - [x] 🔥remove pagination logic in the Indexer. Removing the DB calls also removes the DRF queryset object which handles the pagination. Also we consider pagination not to be necessary for search v1. - [x] 🔥remove the `document/<document_id>/descendants` route. This route is not used anymore. The logic of finding the descendants are moved to the internal `_list_descendants` method. This method is based on the parent `path` instead of the parent `id` which has some consequence about the user access management. Relying on the path prevents the use of the `self.get_object()` method which used to handle the user access logic. - [x] ✨handle fallback logic on DRF based title search in case of non-configured, badly configured or failing at run time indexer. - [x] ✨handle language extension in `title` field. Find returns titles with a language extension (ex: `{ title.fr: "rapport d'activité" }` instead of `{ "title": "rapport d'activité" }`. - [x] 🔧 add a `common.test` file to allow running the tests without docker - [x] ♻️ rename `SearchIndexer` -> `FindDocumentIndexer`. This class has to do with Find in particular and the convention is more coherent with `BaseDocumentIndexer` - [x] ♻️ rename `SEARCH_INDEXER_URL` -> `INDEXING_URL` and `SEARCH_INDEXER_QUERY_URL` -> `SEARCH_URL`. I found the original names very confusing. - [x] 🔧 update the environment variables to activate the FindDocumentIndexer. - [x] ✨automate the generation of encryption key during bootstrap. OIDC_STORE_REFRESH_TOKEN_KEY is a mandatory secret key. We can not push it on Github and we want any contributor to be able to run the app by only running the `make bootstrap`. We chose to generate and wright it into the `common.local` during bootstrap. ## External contributions Thank you for your contribution! 🎉 Please ensure the following items are checked before submitting your pull request: - [x] I have read and followed the [contributing guidelines](https://github.com/suitenumerique/docs/blob/main/CONTRIBUTING.md) - [x] I have read and agreed to the [Code of Conduct](https://github.com/suitenumerique/docs/blob/main/CODE_OF_CONDUCT.md) - [x] I have signed off my commits with `git commit --signoff` (DCO compliance) - [x] I have signed my commits with my SSH or GPG key (`git commit -S`) - [x] My commit messages follow the required format: `<gitmoji>(type) title description` - [x] I have added a changelog entry under `## [Unreleased]` section (if noticeable change) - [x] I have added corresponding tests for new features or bug fixes (if applicable) --------- Signed-off-by: charles <charles.englebert@protonmail.com>
2026-03-17 16:32:03 +00:00
generate-secret-keys:
generate-secret-keys: ## generate secret keys to be stored in common.local
@bin/generate-oidc-store-refresh-token-key.sh
.PHONY: generate-secret-keys
🧑‍💻(compose) remove --no-cache to build images by default In order to speed the rebuild of images, the --no-cache option is removed by default. If we want to build the images without cache, the cache paramter must be used.
2025-06-13 08:31:08 +00:00
pre-bootstrap: \
✨(project) first proof of concept printing pdf from markdown This is a boilerplate inspired from https://github.com/openfun/joanie
2024-01-09 14:30:36 +00:00
data/media \
data/static \
Integrate Find (#1834) ## Purpose integrate Find to Docs ## Proposal - [x] ✨ add a `useSeachDocs` hook in charged of calling the search endpoint. - [x] ✨ add a optional `path` param to the `search` route. This param represents the parent document path in case of a sub-documents (descendants) search. - [x] ⚡️return Indexer results directly without DB calls to retrieve the Document objects. All informations necessary for display are indexed in Find. We can skip the DB calls and improve performance. - [x] ♻️ refactor react `DocSearchContent` components. `DocSearchContent` and `DocSearchSubContent` are now merged a unique component handling all search scenarios and relying on the unique `search` route. - [x] 🔥remove pagination logic in the Indexer. Removing the DB calls also removes the DRF queryset object which handles the pagination. Also we consider pagination not to be necessary for search v1. - [x] 🔥remove the `document/<document_id>/descendants` route. This route is not used anymore. The logic of finding the descendants are moved to the internal `_list_descendants` method. This method is based on the parent `path` instead of the parent `id` which has some consequence about the user access management. Relying on the path prevents the use of the `self.get_object()` method which used to handle the user access logic. - [x] ✨handle fallback logic on DRF based title search in case of non-configured, badly configured or failing at run time indexer. - [x] ✨handle language extension in `title` field. Find returns titles with a language extension (ex: `{ title.fr: "rapport d'activité" }` instead of `{ "title": "rapport d'activité" }`. - [x] 🔧 add a `common.test` file to allow running the tests without docker - [x] ♻️ rename `SearchIndexer` -> `FindDocumentIndexer`. This class has to do with Find in particular and the convention is more coherent with `BaseDocumentIndexer` - [x] ♻️ rename `SEARCH_INDEXER_URL` -> `INDEXING_URL` and `SEARCH_INDEXER_QUERY_URL` -> `SEARCH_URL`. I found the original names very confusing. - [x] 🔧 update the environment variables to activate the FindDocumentIndexer. - [x] ✨automate the generation of encryption key during bootstrap. OIDC_STORE_REFRESH_TOKEN_KEY is a mandatory secret key. We can not push it on Github and we want any contributor to be able to run the app by only running the `make bootstrap`. We chose to generate and wright it into the `common.local` during bootstrap. ## External contributions Thank you for your contribution! 🎉 Please ensure the following items are checked before submitting your pull request: - [x] I have read and followed the [contributing guidelines](https://github.com/suitenumerique/docs/blob/main/CONTRIBUTING.md) - [x] I have read and agreed to the [Code of Conduct](https://github.com/suitenumerique/docs/blob/main/CODE_OF_CONDUCT.md) - [x] I have signed off my commits with `git commit --signoff` (DCO compliance) - [x] I have signed my commits with my SSH or GPG key (`git commit -S`) - [x] My commit messages follow the required format: `<gitmoji>(type) title description` - [x] I have added a changelog entry under `## [Unreleased]` section (if noticeable change) - [x] I have added corresponding tests for new features or bug fixes (if applicable) --------- Signed-off-by: charles <charles.englebert@protonmail.com>
2026-03-17 16:32:03 +00:00
create-env-local-files \
generate-secret-keys
🧑‍💻(compose) remove --no-cache to build images by default In order to speed the rebuild of images, the --no-cache option is removed by default. If we want to build the images without cache, the cache paramter must be used.
2025-06-13 08:31:08 +00:00
.PHONY: pre-bootstrap
🧑‍💻(docker) create a e2e compose configuration We want to run the e2e tests using the frontend and y-provider production images. We created a dedicated compose file adding just missing services. These services are built in the CI.
2025-06-13 08:19:27 +00:00
🧑‍💻(compose) remove --no-cache to build images by default In order to speed the rebuild of images, the --no-cache option is removed by default. If we want to build the images without cache, the cache paramter must be used.
2025-06-13 08:31:08 +00:00
post-bootstrap: \
✨(project) first proof of concept printing pdf from markdown This is a boilerplate inspired from https://github.com/openfun/joanie
2024-01-09 14:30:36 +00:00
migrate \
🤡(backend) demo template Create the create_demo command. It creates a demo template for the backend. We add it in the makefile bootstrap. We force the template id, this id is the same as used in the frontend for the moment. When the template feature will be created in the frontend side we will not have to force it anymore.
2024-04-10 14:29:28 +00:00
demo \
🔧(project) add frontend cmd to Makefile add frontend cmd to Makefile.
2024-04-03 10:33:36 +00:00
back-i18n-compile \
✨(project) first proof of concept printing pdf from markdown This is a boilerplate inspired from https://github.com/openfun/joanie
2024-01-09 14:30:36 +00:00
mails-install \
🧑‍💻(compose) remove --no-cache to build images by default In order to speed the rebuild of images, the --no-cache option is removed by default. If we want to build the images without cache, the cache paramter must be used.
2025-06-13 08:31:08 +00:00
mails-build
.PHONY: post-bootstrap
💄(makefile) add information messages during bootstrap Add nicely formatted messages to the Makefile to indicate the start and end of the bootstrap process. This will help users understand when the bootstrap process begins and ends, improving the overall user experience.
2025-08-04 14:10:42 +00:00
pre-beautiful-bootstrap: ## Display a welcome message before bootstrap
ifeq ($(OS),Windows_NT)
@echo ""
@echo "================================================================================"
@echo ""
@echo " Welcome to Docs - Collaborative Text Editing from La Suite!"
@echo ""
@echo " This will set up your development environment with:"
@echo " - Docker containers for all services"
@echo " - Database migrations and static files"
@echo " - Frontend dependencies and build"
@echo " - Environment configuration files"
@echo ""
@echo " Services will be available at:"
@echo " - Frontend: http://localhost:3000"
@echo " - API: http://localhost:8071"
@echo " - Admin: http://localhost:8071/admin"
@echo ""
@echo "================================================================================"
@echo ""
@echo "Starting bootstrap process..."
else
@echo "$(BOLD)"
@echo "╔══════════════════════════════════════════════════════════════════════════════╗"
@echo "║ ║"
@echo "║ 🚀 Welcome to Docs - Collaborative Text Editing from La Suite ! 🚀 ║"
@echo "║ ║"
@echo "║ This will set up your development environment with : ║"
@echo "║ • Docker containers for all services ║"
@echo "║ • Database migrations and static files ║"
@echo "║ • Frontend dependencies and build ║"
@echo "║ • Environment configuration files ║"
@echo "║ ║"
@echo "║ Services will be available at: ║"
@echo "║ • Frontend: http://localhost:3000 ║"
@echo "║ • API: http://localhost:8071 ║"
@echo "║ • Admin: http://localhost:8071/admin ║"
@echo "║ ║"
@echo "╚══════════════════════════════════════════════════════════════════════════════╝"
@echo "$(RESET)"
@echo "$(GREEN)Starting bootstrap process...$(RESET)"
endif
@echo ""
.PHONY: pre-beautiful-bootstrap
post-beautiful-bootstrap: ## Display a success message after bootstrap
@echo ""
ifeq ($(OS),Windows_NT)
@echo "Bootstrap completed successfully!"
@echo ""
@echo "Next steps:"
@echo " - Visit http://localhost:3000 to access the application"
@echo " - Run 'make help' to see all available commands"
else
@echo "$(GREEN)🎉 Bootstrap completed successfully!$(RESET)"
@echo ""
@echo "$(BOLD)Next steps:$(RESET)"
@echo " • Visit http://localhost:3000 to access the application"
@echo " • Run 'make help' to see all available commands"
endif
@echo ""
.PHONY: post-beautiful-bootstrap
🧑‍💻(compose) remove --no-cache to build images by default In order to speed the rebuild of images, the --no-cache option is removed by default. If we want to build the images without cache, the cache paramter must be used.
2025-06-13 08:31:08 +00:00
✨(backend) add resource server api Adds a resource server API similar to the one that already exists for Drive.
2026-02-26 11:39:14 +00:00
create-docker-network: ## create the docker network if it doesn't exist
@docker network create lasuite-network || true
.PHONY: create-docker-network
💄(makefile) add information messages during bootstrap Add nicely formatted messages to the Makefile to indicate the start and end of the bootstrap process. This will help users understand when the bootstrap process begins and ends, improving the overall user experience.
2025-08-04 14:10:42 +00:00
bootstrap: ## Prepare the project for local development
🧑‍💻(compose) remove --no-cache to build images by default In order to speed the rebuild of images, the --no-cache option is removed by default. If we want to build the images without cache, the cache paramter must be used.
2025-06-13 08:31:08 +00:00
bootstrap: \
💄(makefile) add information messages during bootstrap Add nicely formatted messages to the Makefile to indicate the start and end of the bootstrap process. This will help users understand when the bootstrap process begins and ends, improving the overall user experience.
2025-08-04 14:10:42 +00:00
pre-beautiful-bootstrap \
🧑‍💻(compose) remove --no-cache to build images by default In order to speed the rebuild of images, the --no-cache option is removed by default. If we want to build the images without cache, the cache paramter must be used.
2025-06-13 08:31:08 +00:00
pre-bootstrap \
build \
post-bootstrap \
💄(makefile) add information messages during bootstrap Add nicely formatted messages to the Makefile to indicate the start and end of the bootstrap process. This will help users understand when the bootstrap process begins and ends, improving the overall user experience.
2025-08-04 14:10:42 +00:00
run \
post-beautiful-bootstrap
✨(project) first proof of concept printing pdf from markdown This is a boilerplate inspired from https://github.com/openfun/joanie
2024-01-09 14:30:36 +00:00
.PHONY: bootstrap
🧑‍💻(docker) create a e2e compose configuration We want to run the e2e tests using the frontend and y-provider production images. We created a dedicated compose file adding just missing services. These services are built in the CI.
2025-06-13 08:19:27 +00:00
bootstrap-e2e: ## Prepare Docker production images to be used for e2e tests
bootstrap-e2e: \
🧑‍💻(compose) remove --no-cache to build images by default In order to speed the rebuild of images, the --no-cache option is removed by default. If we want to build the images without cache, the cache paramter must be used.
2025-06-13 08:31:08 +00:00
pre-bootstrap \
🧑‍💻(docker) create a e2e compose configuration We want to run the e2e tests using the frontend and y-provider production images. We created a dedicated compose file adding just missing services. These services are built in the CI.
2025-06-13 08:19:27 +00:00
build-e2e \
🧑‍💻(compose) remove --no-cache to build images by default In order to speed the rebuild of images, the --no-cache option is removed by default. If we want to build the images without cache, the cache paramter must be used.
2025-06-13 08:31:08 +00:00
post-bootstrap \
🧑‍💻(docker) create a e2e compose configuration We want to run the e2e tests using the frontend and y-provider production images. We created a dedicated compose file adding just missing services. These services are built in the CI.
2025-06-13 08:19:27 +00:00
run-e2e
.PHONY: bootstrap-e2e
✨(project) first proof of concept printing pdf from markdown This is a boilerplate inspired from https://github.com/openfun/joanie
2024-01-09 14:30:36 +00:00
# -- Docker/compose
🧑‍💻(compose) remove --no-cache to build images by default In order to speed the rebuild of images, the --no-cache option is removed by default. If we want to build the images without cache, the cache paramter must be used.
2025-06-13 08:31:08 +00:00
build: cache ?=
🧑‍💻(project) improve frontend bootstrap We were providing a frontend development container to the developers, but it was not working properly. Problem of hot reload was present for Windows and Linux users. We stop to provide this development container and we will provide a container connected to the build of the frontend. You can still access the frontend after bootstrap on the "localhost:3000", but if you want to develop you will have to install the frontend dependencies localy and run the frontend in development mode. This will be more efficient and will avoid the problem of hot reload, and right on folder access.
2024-09-16 12:25:42 +00:00
build: ## build the project containers
@$(MAKE) build-backend cache=$(cache)
@$(MAKE) build-yjs-provider cache=$(cache)
@$(MAKE) build-frontend cache=$(cache)
✨(project) first proof of concept printing pdf from markdown This is a boilerplate inspired from https://github.com/openfun/joanie
2024-01-09 14:30:36 +00:00
.PHONY: build
🧑‍💻(project) improve frontend bootstrap We were providing a frontend development container to the developers, but it was not working properly. Problem of hot reload was present for Windows and Linux users. We stop to provide this development container and we will provide a container connected to the build of the frontend. You can still access the frontend after bootstrap on the "localhost:3000", but if you want to develop you will have to install the frontend dependencies localy and run the frontend in development mode. This will be more efficient and will avoid the problem of hot reload, and right on folder access.
2024-09-16 12:25:42 +00:00
build-backend: cache ?=
build-backend: ## build the app-dev container
@$(COMPOSE) build app-dev $(cache)
.PHONY: build-backend
build-yjs-provider: cache ?=
build-yjs-provider: ## build the y-provider container
🧑‍💻(docker) create a e2e compose configuration We want to run the e2e tests using the frontend and y-provider production images. We created a dedicated compose file adding just missing services. These services are built in the CI.
2025-06-13 08:19:27 +00:00
@$(COMPOSE) build y-provider-development $(cache)
🧑‍💻(project) improve frontend bootstrap We were providing a frontend development container to the developers, but it was not working properly. Problem of hot reload was present for Windows and Linux users. We stop to provide this development container and we will provide a container connected to the build of the frontend. You can still access the frontend after bootstrap on the "localhost:3000", but if you want to develop you will have to install the frontend dependencies localy and run the frontend in development mode. This will be more efficient and will avoid the problem of hot reload, and right on folder access.
2024-09-16 12:25:42 +00:00
.PHONY: build-yjs-provider
build-frontend: cache ?=
build-frontend: ## build the frontend container
🔧(docker) add a service in compose to frontend development We want a serice in compose starting the frontend application in development mode. We want to take the advantage of the hot reload module, so the sources are mounted inside the container.
2025-06-02 17:00:13 +00:00
@$(COMPOSE) build frontend-development $(cache)
🧑‍💻(project) improve frontend bootstrap We were providing a frontend development container to the developers, but it was not working properly. Problem of hot reload was present for Windows and Linux users. We stop to provide this development container and we will provide a container connected to the build of the frontend. You can still access the frontend after bootstrap on the "localhost:3000", but if you want to develop you will have to install the frontend dependencies localy and run the frontend in development mode. This will be more efficient and will avoid the problem of hot reload, and right on folder access.
2024-09-16 12:25:42 +00:00
.PHONY: build-frontend
🧑‍💻(compose) remove --no-cache to build images by default In order to speed the rebuild of images, the --no-cache option is removed by default. If we want to build the images without cache, the cache paramter must be used.
2025-06-13 08:31:08 +00:00
build-e2e: cache ?=
🧑‍💻(docker) create a e2e compose configuration We want to run the e2e tests using the frontend and y-provider production images. We created a dedicated compose file adding just missing services. These services are built in the CI.
2025-06-13 08:19:27 +00:00
build-e2e: ## build the e2e container
🧑‍💻(compose) remove --no-cache to build images by default In order to speed the rebuild of images, the --no-cache option is removed by default. If we want to build the images without cache, the cache paramter must be used.
2025-06-13 08:31:08 +00:00
@$(MAKE) build-backend cache=$(cache)
@$(COMPOSE_E2E) build frontend $(cache)
@$(COMPOSE_E2E) build y-provider $(cache)
🧑‍💻(docker) create a e2e compose configuration We want to run the e2e tests using the frontend and y-provider production images. We created a dedicated compose file adding just missing services. These services are built in the CI.
2025-06-13 08:19:27 +00:00
.PHONY: build-e2e
🧑‍💻(nginx) add nginx-frontend To test easily a build application with nginx, we add a nginx-frontend to serve the static files of the application, it will help us to test the application in a more production-like environment.
2026-03-30 14:13:10 +00:00
nginx-frontend: ## build the nginx-frontend container
@$(COMPOSE) up --force-recreate -d nginx-frontend
.PHONY: nginx-frontend
✨(project) first proof of concept printing pdf from markdown This is a boilerplate inspired from https://github.com/openfun/joanie
2024-01-09 14:30:36 +00:00
down: ## stop and remove containers, networks, images, and volumes
🧑‍💻(docker) create a e2e compose configuration We want to run the e2e tests using the frontend and y-provider production images. We created a dedicated compose file adding just missing services. These services are built in the CI.
2025-06-13 08:19:27 +00:00
@$(COMPOSE_E2E) down
✨(project) first proof of concept printing pdf from markdown This is a boilerplate inspired from https://github.com/openfun/joanie
2024-01-09 14:30:36 +00:00
.PHONY: down
logs: ## display app-dev logs (follow mode)
@$(COMPOSE) logs -f app-dev
.PHONY: logs
♻️(make) make run command starting everything The run command is not starting the frontend application. We change the run commands. The run command is strating everything. The run-backend command is starting all services needed to use the backend application.
2025-02-14 11:43:49 +00:00
run-backend: ## Start only the backend application and all needed services
✨(backend) add resource server api Adds a resource server API similar to the one that already exists for Drive.
2026-02-26 11:39:14 +00:00
@$(MAKE) create-docker-network
✨(backend) Import of documents We can now import documents in formats .docx and .md. To do so we added a new container "docspec", which uses the docspec service to convert these formats to Blocknote format. More here: #1567 #1569.
2025-11-15 15:29:43 +00:00
@$(COMPOSE) up --force-recreate -d docspec
✨(project) first proof of concept printing pdf from markdown This is a boilerplate inspired from https://github.com/openfun/joanie
2024-01-09 14:30:36 +00:00
@$(COMPOSE) up --force-recreate -d celery-dev
🧑‍💻(docker) create a e2e compose configuration We want to run the e2e tests using the frontend and y-provider production images. We created a dedicated compose file adding just missing services. These services are built in the CI.
2025-06-13 08:19:27 +00:00
@$(COMPOSE) up --force-recreate -d y-provider-development
✨(backend) add subrequest auth view for collaboration server We need to improve security on the access to The collaboration server We can use the same pattern as for media files leveraging the nginx subrequest feature.
2024-11-18 07:05:54 +00:00
@$(COMPOSE) up --force-recreate -d nginx
♻️(make) make run command starting everything The run command is not starting the frontend application. We change the run commands. The run command is strating everything. The run-backend command is starting all services needed to use the backend application.
2025-02-14 11:43:49 +00:00
.PHONY: run-backend
✨(project) first proof of concept printing pdf from markdown This is a boilerplate inspired from https://github.com/openfun/joanie
2024-01-09 14:30:36 +00:00
♻️(make) make run command starting everything The run command is not starting the frontend application. We change the run commands. The run command is strating everything. The run-backend command is starting all services needed to use the backend application.
2025-02-14 11:43:49 +00:00
run: ## start the wsgi (production) and development server
run:
@$(MAKE) run-backend
🔧(docker) add a service in compose to frontend development We want a serice in compose starting the frontend application in development mode. We want to take the advantage of the hot reload module, so the sources are mounted inside the container.
2025-06-02 17:00:13 +00:00
@$(COMPOSE) up --force-recreate -d frontend-development
♻️(make) make run command starting everything The run command is not starting the frontend application. We change the run commands. The run command is strating everything. The run-backend command is starting all services needed to use the backend application.
2025-02-14 11:43:49 +00:00
.PHONY: run
🧑‍💻(project) improve frontend bootstrap We were providing a frontend development container to the developers, but it was not working properly. Problem of hot reload was present for Windows and Linux users. We stop to provide this development container and we will provide a container connected to the build of the frontend. You can still access the frontend after bootstrap on the "localhost:3000", but if you want to develop you will have to install the frontend dependencies localy and run the frontend in development mode. This will be more efficient and will avoid the problem of hot reload, and right on folder access.
2024-09-16 12:25:42 +00:00
🧑‍💻(docker) create a e2e compose configuration We want to run the e2e tests using the frontend and y-provider production images. We created a dedicated compose file adding just missing services. These services are built in the CI.
2025-06-13 08:19:27 +00:00
run-e2e: ## start the e2e server
run-e2e:
@$(MAKE) run-backend
@$(COMPOSE_E2E) stop y-provider-development
@$(COMPOSE_E2E) up --force-recreate -d frontend
@$(COMPOSE_E2E) up --force-recreate -d y-provider
.PHONY: run-e2e
✨(project) first proof of concept printing pdf from markdown This is a boilerplate inspired from https://github.com/openfun/joanie
2024-01-09 14:30:36 +00:00
status: ## an alias for "docker compose ps"
🧑‍💻(docker) create a e2e compose configuration We want to run the e2e tests using the frontend and y-provider production images. We created a dedicated compose file adding just missing services. These services are built in the CI.
2025-06-13 08:19:27 +00:00
@$(COMPOSE_E2E) ps
✨(project) first proof of concept printing pdf from markdown This is a boilerplate inspired from https://github.com/openfun/joanie
2024-01-09 14:30:36 +00:00
.PHONY: status
stop: ## stop the development server using Docker
🧑‍💻(docker) create a e2e compose configuration We want to run the e2e tests using the frontend and y-provider production images. We created a dedicated compose file adding just missing services. These services are built in the CI.
2025-06-13 08:19:27 +00:00
@$(COMPOSE_E2E) stop
✨(project) first proof of concept printing pdf from markdown This is a boilerplate inspired from https://github.com/openfun/joanie
2024-01-09 14:30:36 +00:00
.PHONY: stop
# -- Backend
demo: ## flush db then create a demo for load testing purpose
@$(MAKE) resetdb
@$(MANAGE) create_demo
.PHONY: demo
✨(backend) add document search indexer Add indexer that loops across documents in the database, formats them as json objects and indexes them in the remote "Find" mico-service.
2025-07-24 10:31:20 +00:00
index: ## index all documents to remote search
@$(MANAGE) index
.PHONY: index
✨(project) first proof of concept printing pdf from markdown This is a boilerplate inspired from https://github.com/openfun/joanie
2024-01-09 14:30:36 +00:00
# Nota bene: Black should come after isort just in case they don't agree...
lint: ## lint back-end python sources
lint: \
lint-ruff-format \
lint-ruff-check \
lint-pylint
.PHONY: lint
lint-ruff-format: ## format back-end python sources with ruff
@echo 'lint:ruff-format started…'
@$(COMPOSE_RUN_APP) ruff format .
.PHONY: lint-ruff-format
lint-ruff-check: ## lint back-end python sources with ruff
@echo 'lint:ruff-check started…'
@$(COMPOSE_RUN_APP) ruff check . --fix
.PHONY: lint-ruff-check
lint-pylint: ## lint back-end python sources with pylint only on changed files from main
@echo 'lint:pylint started…'
bin/pylint --diff-only=origin/main
.PHONY: lint-pylint
test: ## run project tests
@$(MAKE) test-back-parallel
.PHONY: test
test-back: ## run back-end tests
@args="$(filter-out $@,$(MAKECMDGOALS))" && \
bin/pytest $${args:-${1}}
.PHONY: test-back
test-back-parallel: ## run all back-end tests in parallel
@args="$(filter-out $@,$(MAKECMDGOALS))" && \
bin/pytest -n auto $${args:-${1}}
.PHONY: test-back-parallel
♻️(project) rename project from "publish" to "impress" The repository was renamed to "impress" but the code was still mentionning "publish".
2024-03-07 18:46:46 +00:00
makemigrations: ## run django makemigrations for the impress project.
✨(project) first proof of concept printing pdf from markdown This is a boilerplate inspired from https://github.com/openfun/joanie
2024-01-09 14:30:36 +00:00
@echo "$(BOLD)Running makemigrations$(RESET)"
@$(COMPOSE) up -d postgresql
@$(MANAGE) makemigrations
.PHONY: makemigrations
♻️(project) rename project from "publish" to "impress" The repository was renamed to "impress" but the code was still mentionning "publish".
2024-03-07 18:46:46 +00:00
migrate: ## run django migrations for the impress project.
✨(project) first proof of concept printing pdf from markdown This is a boilerplate inspired from https://github.com/openfun/joanie
2024-01-09 14:30:36 +00:00
@echo "$(BOLD)Running migrations$(RESET)"
@$(COMPOSE) up -d postgresql
@$(MANAGE) migrate
.PHONY: migrate
superuser: ## Create an admin superuser with password "admin"
@echo "$(BOLD)Creating a Django superuser$(RESET)"
@$(MANAGE) createsuperuser --email admin@example.com --password admin
.PHONY: superuser
back-i18n-compile: ## compile the gettext files
@$(MANAGE) compilemessages --ignore="venv/**/*"
.PHONY: back-i18n-compile
back-i18n-generate: ## create the .pot files used for i18n
🌐(i18n) translate the invitation email Translate the invitation email. Generate the .po and .mo files thanks to Crowdin.
2024-08-14 12:50:36 +00:00
@$(MANAGE) makemessages -a --keep-pot --all
✨(project) first proof of concept printing pdf from markdown This is a boilerplate inspired from https://github.com/openfun/joanie
2024-01-09 14:30:36 +00:00
.PHONY: back-i18n-generate
shell: ## connect to database shell
@$(MANAGE) shell #_plus
.PHONY: dbshell
# -- Database
dbshell: ## connect to database shell
docker compose exec app-dev python manage.py dbshell
.PHONY: dbshell
✅(e2e) test the pdf export of the impress app Add a test to check the pdf export of the impress app. It intercept the download of the PDF and read its content. We can assert that the template is correctly rendered, and that the pad text is present as well.
2024-04-10 18:05:49 +00:00
resetdb: FLUSH_ARGS ?=
✨(project) first proof of concept printing pdf from markdown This is a boilerplate inspired from https://github.com/openfun/joanie
2024-01-09 14:30:36 +00:00
resetdb: ## flush database and create a superuser "admin"
@echo "$(BOLD)Flush database$(RESET)"
✅(e2e) test the pdf export of the impress app Add a test to check the pdf export of the impress app. It intercept the download of the PDF and read its content. We can assert that the template is correctly rendered, and that the pad text is present as well.
2024-04-10 18:05:49 +00:00
@$(MANAGE) flush $(FLUSH_ARGS)
✨(project) first proof of concept printing pdf from markdown This is a boilerplate inspired from https://github.com/openfun/joanie
2024-01-09 14:30:36 +00:00
@${MAKE} superuser
.PHONY: resetdb
crowdin-download: ## Download translated message from crowdin
@$(COMPOSE_RUN_CROWDIN) download -c crowdin/config.yml
.PHONY: crowdin-download
🔧(project) add frontend cmd to Makefile add frontend cmd to Makefile.
2024-04-03 10:33:36 +00:00
crowdin-download-sources: ## Download sources from Crowdin
@$(COMPOSE_RUN_CROWDIN) download sources -c crowdin/config.yml
.PHONY: crowdin-download-sources
✨(project) first proof of concept printing pdf from markdown This is a boilerplate inspired from https://github.com/openfun/joanie
2024-01-09 14:30:36 +00:00
crowdin-upload: ## Upload source translations to crowdin
@$(COMPOSE_RUN_CROWDIN) upload sources -c crowdin/config.yml
.PHONY: crowdin-upload
i18n-compile: ## compile all translations
i18n-compile: \
🔧(project) add frontend cmd to Makefile add frontend cmd to Makefile.
2024-04-03 10:33:36 +00:00
back-i18n-compile \
frontend-i18n-compile
✨(project) first proof of concept printing pdf from markdown This is a boilerplate inspired from https://github.com/openfun/joanie
2024-01-09 14:30:36 +00:00
.PHONY: i18n-compile
i18n-generate: ## create the .pot files and extract frontend messages
i18n-generate: \
🔧(project) add frontend cmd to Makefile add frontend cmd to Makefile.
2024-04-03 10:33:36 +00:00
back-i18n-generate \
frontend-i18n-generate
✨(project) first proof of concept printing pdf from markdown This is a boilerplate inspired from https://github.com/openfun/joanie
2024-01-09 14:30:36 +00:00
.PHONY: i18n-generate
i18n-download-and-compile: ## download all translated messages and compile them to be used by all applications
i18n-download-and-compile: \
crowdin-download \
i18n-compile
.PHONY: i18n-download-and-compile
🔧(project) add frontend cmd to Makefile add frontend cmd to Makefile.
2024-04-03 10:33:36 +00:00
i18n-generate-and-upload: ## generate source translations for all applications and upload them to Crowdin
✨(project) first proof of concept printing pdf from markdown This is a boilerplate inspired from https://github.com/openfun/joanie
2024-01-09 14:30:36 +00:00
i18n-generate-and-upload: \
i18n-generate \
crowdin-upload
.PHONY: i18n-generate-and-upload
# -- Mail generator
mails-build: ## Convert mjml files to html and text
@$(MAIL_YARN) build
.PHONY: mails-build
mails-build-html-to-plain-text: ## Convert html files to text
@$(MAIL_YARN) build-html-to-plain-text
.PHONY: mails-build-html-to-plain-text
mails-build-mjml-to-html: ## Convert mjml files to html and text
@$(MAIL_YARN) build-mjml-to-html
.PHONY: mails-build-mjml-to-html
mails-install: ## install the mail generator
@$(MAIL_YARN) install
.PHONY: mails-install
# -- Misc
clean: ## restore repository state as it was freshly cloned
git clean -idx
.PHONY: clean
help:
♻️(project) rename project from "publish" to "impress" The repository was renamed to "impress" but the code was still mentionning "publish".
2024-03-07 18:46:46 +00:00
@echo "$(BOLD)impress Makefile"
✨(project) first proof of concept printing pdf from markdown This is a boilerplate inspired from https://github.com/openfun/joanie
2024-01-09 14:30:36 +00:00
@echo "Please use 'make $(BOLD)target$(RESET)' where $(BOLD)target$(RESET) is one of:"
@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(firstword $(MAKEFILE_LIST)) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "$(GREEN)%-30s$(RESET) %s\n", $$1, $$2}'
.PHONY: help
🔧(project) add frontend cmd to Makefile add frontend cmd to Makefile.
2024-04-03 10:33:36 +00:00
🧑‍💻(project) improve frontend bootstrap We were providing a frontend development container to the developers, but it was not working properly. Problem of hot reload was present for Windows and Linux users. We stop to provide this development container and we will provide a container connected to the build of the frontend. You can still access the frontend after bootstrap on the "localhost:3000", but if you want to develop you will have to install the frontend dependencies localy and run the frontend in development mode. This will be more efficient and will avoid the problem of hot reload, and right on folder access.
2024-09-16 12:25:42 +00:00
# Front
♻️(docker) rename frontend-dev service in frontend The frontend-dev service is in fact using the production image. We rename it in frontend accordingly with what it really does. We also have to change name rules in Makefile to be consistent.
2025-02-14 12:10:35 +00:00
frontend-development-install: ## install the frontend locally
🧑‍💻(project) improve frontend bootstrap We were providing a frontend development container to the developers, but it was not working properly. Problem of hot reload was present for Windows and Linux users. We stop to provide this development container and we will provide a container connected to the build of the frontend. You can still access the frontend after bootstrap on the "localhost:3000", but if you want to develop you will have to install the frontend dependencies localy and run the frontend in development mode. This will be more efficient and will avoid the problem of hot reload, and right on folder access.
2024-09-16 12:25:42 +00:00
cd $(PATH_FRONT_IMPRESS) && yarn
♻️(docker) rename frontend-dev service in frontend The frontend-dev service is in fact using the production image. We rename it in frontend accordingly with what it really does. We also have to change name rules in Makefile to be consistent.
2025-02-14 12:10:35 +00:00
.PHONY: frontend-development-install
🧑‍💻(project) improve frontend bootstrap We were providing a frontend development container to the developers, but it was not working properly. Problem of hot reload was present for Windows and Linux users. We stop to provide this development container and we will provide a container connected to the build of the frontend. You can still access the frontend after bootstrap on the "localhost:3000", but if you want to develop you will have to install the frontend dependencies localy and run the frontend in development mode. This will be more efficient and will avoid the problem of hot reload, and right on folder access.
2024-09-16 12:25:42 +00:00
🧑‍💻(makefile) add frontend-lint cmd Add the command frontend-lint to the makefile.
2024-10-23 10:26:35 +00:00
frontend-lint: ## run the frontend linter
cd $(PATH_FRONT) && yarn lint
.PHONY: frontend-lint
🧑‍💻(project) improve frontend bootstrap We were providing a frontend development container to the developers, but it was not working properly. Problem of hot reload was present for Windows and Linux users. We stop to provide this development container and we will provide a container connected to the build of the frontend. You can still access the frontend after bootstrap on the "localhost:3000", but if you want to develop you will have to install the frontend dependencies localy and run the frontend in development mode. This will be more efficient and will avoid the problem of hot reload, and right on folder access.
2024-09-16 12:25:42 +00:00
run-frontend-development: ## Run the frontend in development mode
fix: Makefile failing on run-frontend-development (#1104) See #1103 Signed-off-by: Stephan Meijer <me@stephanmeijer.com>
2025-06-27 12:35:55 +00:00
@$(COMPOSE) stop frontend-development
🧑‍💻(project) improve frontend bootstrap We were providing a frontend development container to the developers, but it was not working properly. Problem of hot reload was present for Windows and Linux users. We stop to provide this development container and we will provide a container connected to the build of the frontend. You can still access the frontend after bootstrap on the "localhost:3000", but if you want to develop you will have to install the frontend dependencies localy and run the frontend in development mode. This will be more efficient and will avoid the problem of hot reload, and right on folder access.
2024-09-16 12:25:42 +00:00
cd $(PATH_FRONT_IMPRESS) && yarn dev
.PHONY: run-frontend-development
🔧(project) add frontend cmd to Makefile add frontend cmd to Makefile.
2024-04-03 10:33:36 +00:00
✨(frontend) use title first emoji as doc icon in tree Implemented emoji detection system, new DocIcon component.
2025-08-29 08:25:40 +00:00
frontend-test: ## Run the frontend tests
cd $(PATH_FRONT_IMPRESS) && yarn test
.PHONY: frontend-test
🔧(project) add frontend cmd to Makefile add frontend cmd to Makefile.
2024-04-03 10:33:36 +00:00
frontend-i18n-extract: ## Extract the frontend translation inside a json to be used for crowdin
cd $(PATH_FRONT) && yarn i18n:extract
.PHONY: frontend-i18n-extract
frontend-i18n-generate: ## Generate the frontend json files used for crowdin
frontend-i18n-generate: \
crowdin-download-sources \
frontend-i18n-extract
.PHONY: frontend-i18n-generate
frontend-i18n-compile: ## Format the crowin json files used deploy to the apps
cd $(PATH_FRONT) && yarn i18n:deploy
🚚(k8s) move tilt config to bin Move tilt config to bin directory to keep the root directory clean. Add makefile cmd about k8s.
2024-04-12 21:02:03 +00:00
.PHONY: frontend-i18n-compile
# -- K8S
build-k8s-cluster: ## build the kubernetes cluster using kind
./bin/start-kind.sh
.PHONY: build-k8s-cluster
start-tilt: ## start the kubernetes cluster using kind
tilt up -f ./bin/Tiltfile
✨(docker-compose) add minio for object storage We will need object storage to store our document content which comes as a big json object. Storing it in object storage will offer us versioning, robustness and scalability.
2024-04-05 18:05:18 +00:00
.PHONY: build-k8s-cluster
🧑‍💻(project) improve frontend bootstrap We were providing a frontend development container to the developers, but it was not working properly. Problem of hot reload was present for Windows and Linux users. We stop to provide this development container and we will provide a container connected to the build of the frontend. You can still access the frontend after bootstrap on the "localhost:3000", but if you want to develop you will have to install the frontend dependencies localy and run the frontend in development mode. This will be more efficient and will avoid the problem of hot reload, and right on folder access.
2024-09-16 12:25:42 +00:00
bump-packages-version: VERSION_TYPE ?= minor
🧑‍💻(makefile) bump-packages-version Create the command bump-packages-version in Makefile. This command will bump the version of all the javascript packages in the project.
2024-08-23 13:59:50 +00:00
bump-packages-version: ## bump the version of the project - VERSION_TYPE can be "major", "minor", "patch"
cd ./src/mail && yarn version --no-git-tag-version --$(VERSION_TYPE)
cd ./src/frontend/ && yarn version --no-git-tag-version --$(VERSION_TYPE)
cd ./src/frontend/apps/e2e/ && yarn version --no-git-tag-version --$(VERSION_TYPE)
cd ./src/frontend/apps/impress/ && yarn version --no-git-tag-version --$(VERSION_TYPE)
🔧(project) replace webrtc by yProvider Replace webrtc by yProvider the project (docker, helm chart, etc).
2024-09-04 14:56:40 +00:00
cd ./src/frontend/servers/y-provider/ && yarn version --no-git-tag-version --$(VERSION_TYPE)
⬆️(dependency) upgrade eslint to v9 We upgraded ESLint to version 9 in the eslint-config-impress package. We rename it to eslint-plugin-docs.
2025-08-08 12:43:25 +00:00
cd ./src/frontend/packages/eslint-plugin-docs/ && yarn version --no-git-tag-version --$(VERSION_TYPE)
🧑‍💻(makefile) bump-packages-version Create the command bump-packages-version in Makefile. This command will bump the version of all the javascript packages in the project.
2024-08-23 13:59:50 +00:00
cd ./src/frontend/packages/i18n/ && yarn version --no-git-tag-version --$(VERSION_TYPE)
.PHONY: bump-packages-version
Reference in a new issue Copy permalink