Skip to content
Snippets Groups Projects
Commit 7322925b authored by Remi  PLANEL's avatar Remi PLANEL
Browse files

Update README on how to start app locally

parent e7483a62
No related branches found
No related tags found
1 merge request!27Issue #145. Added page template and reviewer guide
Pipeline #114846 passed
# Knowledge database of information about defense systems in prokaryotes # 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. 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. 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 ...@@ -37,43 +65,20 @@ For person external, you can create an [issue](https://gitlab.pasteur.fr/mdm-lab
## Contributing ## Contributing
Look at the [Content documentation](https://content-v2.nuxtjs.org/) to learn more. ### Run locally
### Setup
Make sure to install the dependencies:
```bash 1. install `Docker` and `Docker Compose` ([installation guide](https://docs.docker.com/engine/install/))
# yarn
yarn install
# npm 2. Clone the repo
npm install ```sh
git clone https://gitlab.pasteur.fr/mdm-lab/wiki.git`
# pnpm
pnpm install
``` ```
3. Go to the repo :
### Development Server ```sh
cd wiki
Start the development server on <http://localhost:3000>
```bash
npm run dev
``` ```
4. Start the app:
### Production ```sh
docker compose up --build
Build the application for production:
```bash
npm run build
``` ```
5. Go to [localhost:8082/wiki](localhost:8082/wiki)
Locally preview production build:
```bash
npm run preview
```
Checkout the [deployment documentation](https://v3.nuxtjs.org/docs/deployment) for more information.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment