|
1 | | -# counters |
2 | | -Days Since Last Useless House Service was Mode: 0 |
3 | | -```mermaid |
4 | | -erDiagram |
5 | | -
|
6 | | - RESET { |
7 | | - string username |
8 | | - string description |
9 | | - time timestamp |
10 | | - } |
11 | | - COUNTER { |
12 | | - string id |
13 | | - string createdBy |
14 | | - string title |
15 | | - string description |
16 | | - RESET lastReset |
17 | | - list[RESET] history |
18 | | - } |
| 1 | +# Counters  |
| 2 | +## Day's Since Last Useless House Service was Made: 0 |
19 | 3 |
|
20 | | -``` |
| 4 | +A simple interface for logging and displaying time since a certain event has occured, allowing for CSHer's to track how long its been since a prior event. Heavily inspired off the "Days since last..." meme format. |
| 5 | + |
| 6 | +This project uses Golang, [Gin](https://fastapi.tiangolo.com/), HTML/CSS, and Javascript. |
21 | 7 |
|
22 | | -__TODO__ |
| 8 | +This project ALSO uses a modified version of bootstrap 5! Check it out [here!](https://github.com/ComputerScienceHouse/csh-material-bootstrap/tree/bootstrap-5) |
23 | 9 |
|
24 | | -[] Load History |
| 10 | +## Installing |
| 11 | +1. Clone and cd into the repo: git clone https://github.com/WeatherGod3218/counters |
| 12 | +>> (OPTIONAL): Make another branch if your working on a large thing! |
25 | 13 |
|
26 | | -[] Allow adding a reset |
| 14 | +## Setup |
| 15 | +1. Make sure you have docker installed |
| 16 | +>> (OPTIONAL): You can use docker compose as well!! |
| 17 | +2. Copy the .env.template file, rename it to .env and place it in the root folder |
| 18 | +3. Ask an RTP for counters secrets, add them to the .env accordingly |
27 | 19 |
|
28 | | -[] Implement csh-auth |
| 20 | +## Run |
29 | 21 |
|
30 | | -[] Make Sections Smaller in Width |
| 22 | +Counters is containerized through a docker file. |
31 | 23 |
|
| 24 | +1. Build the docker file |
| 25 | +``` |
| 26 | + docker build -t Counters . |
| 27 | +``` |
| 28 | +2. Run the newly built docker on port 8000 |
| 29 | +``` |
| 30 | + docker run -p 8080:80 Counters |
| 31 | +``` |
| 32 | + |
| 33 | +## Docker Compose |
| 34 | + |
| 35 | +Counters also has support for Docker Compose, a extended version of docker that simplifies the steps. |
| 36 | + |
| 37 | +(This is a really cool thing! If you use docker often, check it out!) |
| 38 | +``` |
| 39 | + docker compose up |
| 40 | +``` |
0 commit comments