Skip to content

ABI-CTT-Group/breast-educational-resource

Repository files navigation

Breast APP

Read the Docs

Setup Project

Install with PWA

Setup App

  • Setup frontend
    • Environment: node 16.14.0/16.16.0, yarn 1.22.19
    • Download node via nvm node manager
# install nodejs
nvm install 16.16.0
nvm alias default 16.16.0
nvm use
# check node version
node -v
# install yarn globally
cd frontend
npm install -g yarn

# install frontend dependencies
yarn
# run frontend
yarn dev

Work with docs

You can write the docs with reStructuredText in .rst or markdownin .md format.

cd docs
# After you edit the docs, you want view it locally
# windows
./make html
# mac or linux
# make html

# install this package if you haven't installed it before
# npm i live-server -g

cd build/html

live-server

Important documentation