Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
W
Wiki
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
GitLab community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
MDM Lab
Wiki
Commits
7322925b
Commit
7322925b
authored
1 year ago
by
Remi PLANEL
Browse files
Options
Downloads
Patches
Plain Diff
Update README on how to start app locally
parent
e7483a62
No related branches found
No related tags found
1 merge request
!27
Issue #145. Added page template and reviewer guide
Pipeline
#114846
passed
1 year ago
Stage: build
Changes
1
Pipelines
2
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+41
-36
41 additions, 36 deletions
README.md
with
41 additions
and
36 deletions
README.md
+
41
−
36
View file @
7322925b
# 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.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment