Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
W
Wiki
Manage
Activity
Members
Labels
Plan
Issues
52
Issue boards
Milestones
Wiki
Code
Merge requests
8
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
MDM Lab
Wiki
Merge requests
!27
Issue
#145
. Added page template and reviewer guide
Code
Review changes
Check out branch
Download
Patches
Plain diff
Merged
Issue
#145
. Added page template and reviewer guide
145-draft-template-and-requirement-checklist
into
main
Overview
6
Commits
13
Pipelines
21
Changes
10
Merged
hvaysset
requested to merge
145-draft-template-and-requirement-checklist
into
main
1 year ago
Overview
6
Commits
13
Pipelines
21
Changes
1
Expand
Closes
#145 (closed)
0
0
Merge request reports
Viewing commit
7322925b
Prev
Next
Show latest version
1 file
+
41
−
36
Inline
Compare changes
Side-by-side
Inline
Show whitespace changes
Show one file at a time
7322925b
Update README on how to start app locally
· 7322925b
Remi PLANEL
authored
1 year ago
README.md
+
17
−
36
Options
# 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
)
).
### 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 +41,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
)