bjwz-china/backup

Team BJWZ-China 2023 Wiki

This repository MUST contain all coding assets to generate your team's wiki (HTML, CSS, JavaScript, TypeScript, Python, etc).

Images, photos, icons and fonts MUST be stored on static.igem.wiki using uploads.igem.org, and Videos must be embedded from iGEM Video Universe.

For up-to-date requirements, resources, help and guidance, visit competition.igem.org/deliverables/team-wiki.

Getting started

You should probably only edit the files inside folders static, wiki and wiki > pages.

1. Open the Web IDE
2. Make the changes on the files you wish:
   • For the menu, change the file menu.html
   • For the layout, change the file layout.html
   • For the pages, change the corresponding file in the foler pages
3. Review the changes you made
4. Once you are done, save the changes by committing them to the main branch of the repository
5. An automated script will build, test and deploy your wiki, which should take less than 30 seconds.

About this Template

Files

The static assets are in the static directory. The layout and templates are in the wiki directory, and the pages live in the wiki > pages directory. Unless you are an experienced and/or adventurous human, you probably shouldn't change other files.

|__ static/             -> static assets (CSS and JavaScript files only)
|__ wiki/               -> Main directory for the pages and layouts
    |__ footer.html     -> Footer that will appear in all the pages
    |__ layout.html     -> Main layout of your wiki. All the pages will follow its structure
    |__ menu.html       -> Menu that will appear in all the pages
    |__ pages/          -> Directory for all the pages
        |__ *.html      -> Actual pages of your wiki
|__ .gitignore          -> Tells GitLab which files/directories should not be uploaded to the repository
|__ .gitlab-ci.yml      -> Automated flow for building, testing and deploying your website.
|__ LICENSE             -> License CC-by-4.0, all wikis are required to have this license - DO NOT MODIFY
|__ README.md           -> File containing the text you are reading right now
|__ app.py              -> Python code managing your wiki
|__ dependencies.txt    -> Software dependencies from the Python code

Technologies

• GitLab Pages
• Python: Programming language
• Flask: Python framework
• Fronzen-Flask: Library that builds the wiki to be deployed as a static website
• Bootstrap: CSS and JS components used

Building locally (advanced users)

To work locally with this project, follow the steps below:

Install

git clone https://gitlab.igem.org/2023/bjwz-china.git
cd bjwz-china
python3 -m venv venv
. venv/bin/activate # on Linux, MacOS; or
. venv\Scripts\activate # on Windows
pip install -r dependencies.txt

Execute

python app.py