diff --git a/.gitignore b/.gitignore index 294bd6cb..7c608241 100644 --- a/.gitignore +++ b/.gitignore @@ -3,5 +3,5 @@ env.py *.py[cod] __pycache__/ *.sqlite3 -static/ -media/ +# static/ +# media/ diff --git a/README.md b/README.md new file mode 100644 index 00000000..2215435a --- /dev/null +++ b/README.md @@ -0,0 +1,154 @@ +# CI Hackathon App + +--- + +## Table of Contents +1. [**Contributing**](#contributing) + +2. [**UX**](#ux) + - [**User Stories**](#user-stories) + - [**Design**](#design) + - [**Framework**](#framework) + - [**Color Scheme**](#color-scheme) + - [**Icons**](#icons) + - [**Typography**](#typography) + - [**Wireframes**](#wireframes) + +3. [**Features**](#features) + - [**Existing Features**](#existing-features) + - [**Features Left to Implement**](#features-left-to-implement) + +4. [**Technologies Used**](#technologies-used) + - [**Front-End Technologies**](#front-end-technologies) + - [**Back-End Technologies**](#back-end-technologies) + +5. [**Testing**](#testing) + - [**Validators**](#validators) + - [**Compatibility**](#compatibility) + - [**Known Issues**](#known-issues) + - [**Automated Testing**](#automated-testing) + +5. [**Deployment**](#deployment) + - [**Local Deployment**](#local-deployment) + - [**Remote Deployment**](#remote-deployment) + +7. [**Credits**](#credits) + - [**Content**](#content) + - [**Media**](#media) + - [**Code**](#code) + - [**Acknowledgements**](#acknowledgements) + +--- + +## Contributing + +xx [link to CONTRIBUTING.md]() + +##### back to [top](#table-of-contents) + +--- + +## UX + +xx + +### User Stories + +- [x] *successfully implemented* +- [ ] *not yet implemented* + +"**_As a Student, I would like to_** _______________" + +- [ ] User Story (student) #1. +- [ ] User Story (student) #2. +- [ ] User Story (student) #3. + +"**_As CI Staff, I would like to_** _______________" + +- [ ] User Story (staff) #1. +- [ ] User Story (staff) #2. +- [ ] User Story (staff) #3. + +### Design + +xx + +#### Framework + +- [MD Bootstrap?]() +- [Materialize?]() +- [Bootstrap?]() + +#### Color Scheme + +*Palette*: **Primary Colors** + +| `--p-orange` | `--p-blue` | `--p-grey` | `--p-navy` | `--p-red` | +| :---: | :---: | :---: | :---: | :---: | +| ![#E84610](https://placehold.it/15/E84610/E84610) | ![#009FE3](https://placehold.it/15/009FE3/009FE3) | ![#4A4A4F](https://placehold.it/15/4A4A4F/4A4A4F) | ![#445261](https://placehold.it/15/445261/445261) | ![#D63649](https://placehold.it/15/D63649/D63649) | +| #E84610 | #009FE3 | #4A4A4F | #445261 | #D63649 | + +*Palette*: **Secondary Colors** + +| `--s-grey` | `--s-yellow` | `--s-pink` | `--s-teal` | +| :---: | :---: | :---: | :---: | :---: | +| ![#E6ECF0](https://placehold.it/15/E6ECF0/E6ECF0) | ![#EFB920](https://placehold.it/15/EFB920/EFB920) | ![#FF5A60](https://placehold.it/15/FF5A60/FF5A60) | ![#23BBBB](https://placehold.it/15/23BBBB/23BBBB) | +| #E6ECF0 | #EFB920 | #FF5A60 | #23BBBB | + +*Palette*: **Tertiary Colors** + +| `--t-grey` | +| :---: | :---: | :---: | :---: | :---: | +| ![#E0E7FF](https://placehold.it/15/E0E7FF/E0E7FF) | +| #E0E7FF | + +**CSS Color `:root` Variables** + +```css +:root { + /* P = Primary | S = Secondary | T = Tertiary */ + --p-orange: #E84610; + --p-blue: #009FE3; + --p-grey: #4A4A4F; + --p-navy: #445261; + --p-red: #D63649; + --s-grey: #E6ECF0; + --s-yellow: #EFB920; + --s-pink: #FF5A60; + --s-teal: #23BBBB; + --t-grey: #E0E7FF; + --bg-grey: #F5F5F5; +} + +/* How To Use CSS Root Variables */ + +element { + color: var(--p-orange); + background-color: var(--bg-grey); +} +``` + +#### Icons + +- [Font Awesome 5.14](https://fontawesome.com/) + +#### Typography + +- [Google Fonts](https://fonts.google.com/) + +### Wireframes + +xx + +##### back to [top](#table-of-contents) + +--- + +## Features + +xx + + + + +![flow-chart](static/img/flow-chart.png?raw=true "flow-chart") \ No newline at end of file diff --git a/static/img/flow-chart.png b/static/img/flow-chart.png new file mode 100644 index 00000000..08957197 Binary files /dev/null and b/static/img/flow-chart.png differ