From 658abe4efa9a09de54ed68bb5b8f2b1ca85a072f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Steven=20H=C3=A9=20=28S=C4=ABch=C3=A0ng=29?= <sichang.he@dukekunshan.edu.cn> Date: Sun, 2 Oct 2022 11:39:22 -0400 Subject: [PATCH] README refer to resources --- README.md | 69 +++++-------------------------------------------------- 1 file changed, 6 insertions(+), 63 deletions(-) diff --git a/README.md b/README.md index 6a7f040..0fcef06 100644 --- a/README.md +++ b/README.md @@ -1,66 +1,9 @@ # Team DKU 2022 Wiki -This repository **MUST** contain all coding assets to generate your team's wiki (HTML, CSS, JavaScript, TypeScript, Python, etc). +This repository is for the deployment of iGEM 2022 DKU team. -Images, photos, icons and fonts **MUST** be stored on `static.igem.wiki` using [uploads.igem.org](https://uploads.igem.org), and Videos **must** be embedded from [iGEM Video Universe](https://video.igem.org). - -For up-to-date requirements, resources, help and guidance, visit [competition.igem.org/deliverables/team-wiki](https://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 -1. Make the changes on the files you wish: - * For the menu, change the file [menu.html](wiki/menu.html) - * For the layout, change the file [layout.html](wiki/layout.html) - * For the pages, change the corresponding file in the foler [pages](wiki/pages) -1. Review the changes you made -1. Once you are done, save the changes by **committing** them to the *main branch* of the repository -1. 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 - |__ wiki-tools.html -> Wiki tools to help getting started with this template - |__ 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](https://docs.gitlab.com/ee/user/project/pages/) - * [Python](https://www.python.org): Programming language - * [Flask](https://palletsprojects.com/p/flask/): Python framework - * [Fronzen-Flask](https://pythonhosted.org/Frozen-Flask): Library that builds the wiki to be deployed as a static website - * [Bootstrap](https://getbootstrap.com/docs/5.0/components): CSS and JS components used - -### Building locally (advanced users) - -To work locally with this project, you'll have to follow the steps below: - -#### Install -```bash -git clone https://gitlab.igem.org/2022/dku -cd example -python3 -m venv venv -. venv/bin/activate -pip install -r dependencies.txt -``` - -#### Execute -```bash -python app.py -``` +For simplicity of development and collaboration, +the wiki was developed on +[our Duke GitLab](https://gitlab.oit.duke.edu/sh623/igem-2022-dku), +and the backup is on +[GitHub](https://github.com/SichangHe/igem-2022-dku-backup). -- GitLab