We use this to guarantee the same structure for all projects. Projects will be then uploaded to our project page and there these information will be displayed. So you can check at any time the project page to have an idea about how that would look like.
- if you are reading on Github, clone or download this repository to your computer.
- rename the folder
project_template_folderto the name of your project (please avoid spaces in the name of the folder). - complete the
INFO.mdfile with title, description, students name, course, semester and whatever is asked there - upload the required documents:
- the code (one or more notebooks or python code) in the
codefolder. Inside the folder there is already a notebook with some informations. Please make sure to check it and start from there. - a picture of that represent your project in the
previewfolder. It will be used as a preview for the online visualization. It should have width larger than its height (something like 500x280 may work good), but it's not absolutely necessary. It will be centered anyway. Higher resolution will be down-scaled, so do not upload images higher than 720 pixels. - other resources you may need in the
resourcesfolder - please do not upload the dataset you used unless there are special reasons.
- the code (one or more notebooks or python code) in the
- (Optional) rename
INFO.mdasREADME.md. This way when people open your repository page, they will see the information about your project (and not the instructions to upload it). TheREADME.mdfile is automatically showed from github. - compress the whole folder as a
.zipfile and check the size. Please do not upload files larger than10Mb. If you have special reason to do so, please let us know before you upload. - upload the
.zipfile in your course's online page. If you do not know where, ask your teacher.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent