From 7322925b0c81e3cc2eab663bab5f649b33500f46 Mon Sep 17 00:00:00 2001 From: Remi PLANEL <rplanel@pasteur.fr> Date: Tue, 31 Oct 2023 10:39:22 +0100 Subject: [PATCH] Update README on how to start app locally --- README.md | 77 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 41 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 6e0b55d4..4abe72ad 100755 --- a/README.md +++ b/README.md @@ -1,6 +1,34 @@ # Knowledge database of information about defense systems in prokaryotes -## How to use references in the wiki pages +## Writting content + +You can propose modifications for all the content (cf: [help](https://defense-finder.pasteur.cloud/wiki/help)). + +### Custom containers + +``` +::info +This is an info box +:: + +::tip +This is a tip box +:: + +::warning +This is a warning box +:: + +::danger +This is a danger box +:: + +::expansion-details +There is some details +:: +``` + +### How to use references in the wiki pages You can add article references by providing a doi directly in the markdown files. There is two syntaxes that won't do exactly the same thing. @@ -37,43 +65,20 @@ For person external, you can create an [issue](https://gitlab.pasteur.fr/mdm-lab ## Contributing -Look at the [Content documentation](https://content-v2.nuxtjs.org/) to learn more. - -### Setup - -Make sure to install the dependencies: +### Run locally -```bash -# yarn -yarn install +1. install `Docker` and `Docker Compose` ([installation guide](https://docs.docker.com/engine/install/)) -# npm -npm install - -# pnpm -pnpm install +2. Clone the repo +```sh +git clone https://gitlab.pasteur.fr/mdm-lab/wiki.git` ``` - -### Development Server - -Start the development server on <http://localhost:3000> - -```bash -npm run dev +3. Go to the repo : +```sh +cd wiki ``` - -### Production - -Build the application for production: - -```bash -npm run build +4. Start the app: +```sh +docker compose up --build ``` - -Locally preview production build: - -```bash -npm run preview -``` - -Checkout the [deployment documentation](https://v3.nuxtjs.org/docs/deployment) for more information. +5. Go to [localhost:8082/wiki](localhost:8082/wiki) -- GitLab