Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/INCF/niQC
NeuroImaging Quality Control (niQC)
https://github.com/INCF/niQC
neuroimaging neuroscience protocols quality-control standards
Last synced: 1 day ago
JSON representation
NeuroImaging Quality Control (niQC)
- Host: GitHub
- URL: https://github.com/INCF/niQC
- Owner: INCF
- License: mit
- Created: 2018-10-01T11:49:57.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-30T10:42:57.000Z (8 months ago)
- Last Synced: 2024-08-03T15:06:22.244Z (3 months ago)
- Topics: neuroimaging, neuroscience, protocols, quality-control, standards
- Language: JavaScript
- Homepage: https://incf.github.io/niQC/
- Size: 14.1 MB
- Stars: 13
- Watchers: 16
- Forks: 15
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NeuroImaging Quality Control (niQC)
Repository for the niQC website.
## Basic Structure
This website is built over Gatsby, a static site generator. After each commit on branch `master`, it will rebuild the entire website with the new changes and deploy it to https://incf.github.io/niQC/
All the content is inside the folder `content` in Markdown format.
To create a new page, follow the structure of pages under `content/pages`. It requires a folder, containing an `index.md` file.
The `index.md` file may contain the page content, with the following header:
```markdown
---
path: "/about"
title: "About"
menu: 4
---
# About!
```
The `path` key indicates the URL for the page. In the example, the full URL will be: `https://incf.github.io/niQC/about`. A trailing slash is not required.
The `title` key indicates the page title, replicated on the page title tag (``) and in the beginning of the page.
The `menu` key indicates if the page should be shown in the header menu. If `menu` is lesser then one, it will not be displayed in the menu.
Everything beyond the last `---` will be considered page content.
## How to collaborate
In order to suggest modifications, you need to open a pull request from your fork of this website. After proper review, your code will be merged into the `master` branch.
Steps:
- Fork the [niQC repo](https://github.com/INCF/niQC/fork)
- Find the page you would like to contribute to under `content/pages` and edit the `index.md` markdown page
- Send us pull a request
- If you are confused or having trouble, just [open an issue](https://github.com/INCF/niQC/issues/new) at the .
Thank you for your interest in contributing to this effort.
## Running locally using Docker
You can start a development server using Docker:
```bash
docker run -it -p 9000:9000 -v `pwd`:/opt/code -w /opt/code node:11.15.0 bash -c 'npm i; npm run develop'
```
This command will spawn a container, install the required dependencies for the project, and start the development server. You can access it at `http://localhost:9000`. The website content will be recompiled and refreshed every time a file is changed.