From c120ad4b844383ebfccb67ead5d0eb6f8596759c Mon Sep 17 00:00:00 2001 From: virgile-deville Date: Fri, 21 Feb 2025 15:21:21 +0100 Subject: [PATCH 1/2] =?UTF-8?q?=F0=9F=93=9D(readme)=20move=20front-end=20l?= =?UTF-8?q?ocal=20run=20instructions?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit New comers should only see the main info. I removed the special commands from the readme. And moved them to the /docs/local.md --- README.md | 22 +----------- docs/local.md | 92 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 93 insertions(+), 21 deletions(-) create mode 100644 docs/local.md diff --git a/README.md b/README.md index c024440b1..a67e8f611 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ Docs is a collaborative text editor designed to address common challenges in kno * πŸ“š Built-in wiki functionality to turn your team's collaborative work into organized knowledge `ETA 02/2025` ### Self-host -* πŸš€ Easy to install, scalable and secure alternative to Notion, Outline or Confluence +* πŸš€ Easy to install, scalable and secure alternative to Notion and Outline. ## Getting started πŸ”§ @@ -100,26 +100,6 @@ password: impress $ make run ``` -⚠️ For the frontend developer, it is often better to run the frontend in development mode locally. - -To do so, install the frontend dependencies with the following command: - -```shellscript -$ make frontend-development-install -``` - -And run the frontend locally in development mode with the following command: - -```shellscript -$ make run-frontend-development -``` - -To start all the services, except the frontend container, you can use the following command: - -```shellscript -$ make run-backend -``` - **Adding content** You can create a basic demo site by running: diff --git a/docs/local.md b/docs/local.md new file mode 100644 index 000000000..b53c45248 --- /dev/null +++ b/docs/local.md @@ -0,0 +1,92 @@ +# Run Docs locally + +> ⚠️ Running Docs locally using the methods described below is for testing purposes only. It is based on building Docs using Minio as the S3 storage solution: if you want to use Minio for production deployment of Docs, you will need to comply with Minio's AGPL-3.0 licence. + +**Prerequisite** + +Make sure you have a recent version of Docker and [Docker Compose](https://docs.docker.com/compose/install) installed on your laptop: + +```shellscript +$ docker -v + +Docker version 20.10.2, build 2291f61 + +$ docker compose version + +Docker Compose version v2.32.4 +``` + +> ⚠️ You may need to run the following commands with sudo but this can be avoided by adding your user to the `docker` group. + +**Project bootstrap** + +The easiest way to start working on the project is to use GNU Make: + +```shellscript +$ make bootstrap FLUSH_ARGS='--no-input' +``` + +This command builds the `app` container, installs dependencies, performs database migrations and compile translations. It's a good idea to use this command each time you are pulling code from the project repository to avoid dependency-related or migration-related issues. + +Your Docker services should now be up and running πŸŽ‰ + +You can access to the project by going to . + +You will be prompted to log in, the default credentials are: + +``` +username: impress +password: impress +``` + +πŸ“ Note that if you need to run them afterwards, you can use the eponym Make rule: + +```shellscript +$ make run +``` + +**Adding content** +You can create a basic demo site by running: + +```shellscript +$ make demo +``` + +Finally, you can check all available Make rules using: + +```shellscript +$ make help +``` + +**Django admin** + +You can access the Django admin site at + +. + +You first need to create a superuser account: + +```shellscript +$ make superuser +``` + +## Front-end dev instructions +⚠️ For the frontend developer, it is often better to run the frontend in development mode locally. + +To do so, install the frontend dependencies with the following command: + +```shellscript +$ make frontend-development-install +``` + +And run the frontend locally in development mode with the following command: + +```shellscript +$ make run-frontend-development +``` + +To start all the services, except the frontend container, you can use the following command: + +```shellscript +$ make run-backend +``` From faf38de099bb63206aa7feb785c00d9200b3ff6d Mon Sep 17 00:00:00 2001 From: virgile-deville Date: Fri, 21 Feb 2025 15:24:15 +0100 Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=93=9D(readme)=20add=20changelog=20en?= =?UTF-8?q?try?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Added changelog entry so the pr passes the test --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4ddf0ce23..6aa5f7c88 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,7 @@ and this project adheres to - πŸ›‚(frontend) Restore version visibility #629 - πŸ“(doc) minor README.md formatting and wording enhancements - ♻️Stop setting a default title on doc creation #634 +- πŸ“(readme) remove front-end local run instructions local.md #651 ## Fixed