Skip to content

Latest commit

 

History

History
88 lines (64 loc) · 1.8 KB

README.md

File metadata and controls

88 lines (64 loc) · 1.8 KB
Raw

Web App Template

Read the Docs

Setup Project

With backend

  • Clone template to PC
git clone https://github.com/ABI-CTT-Group/web-app-template.git
cd web-app-template
  • Setup backend
    • environemnt: python 3.9+
cd backend
pip install -r requirements.txt
uvicorn myapp:custom_app_instance --reload
  • 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

Without backend

  • delete backend folder
  • modify code in frontend
# delete components/model/Model.vue async fetch() line 17 ~ 27
  • put your data into static folder, then you can the data file path into your frontend code directly.

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