Skip to content

Commit 266bc65

Browse files
MathyouMBMathyouMB
authored
update documentation (#6)
* updated nested relation ordering * add new line * updated documentation * updated toc * grammar * update toc * add space * new section * sub section * heading * combine * update
1 parent 303fe77 commit 266bc65

7 files changed

+104
-9
lines changed

‎assets/codechallenges_schema.drawio

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<mxfile host="app.diagrams.net" modified="2021-02-15T04:55:25.834Z" agent="5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.150 Safari/537.36" etag="4oi1s3SFT-W7bSCq4KxC" version="14.2.7" type="device"><diagram id="O3KLrP1naxKt7Erf4wuU" name="Page-1">7Zxdb6M4FIZ/TS5nFL7S5HJL21lpO9LsdLU7czVygwNeOZgap0n2168d7JDg0KYNxKZBqip8MAbOe3hwDgcGXjhffaEgS76SCOKBO4xWA+9m4LoTf8T/C8O6MIyUIaYoKkxOaXhA/0FpHErrAkUw3+vICMEMZfvGKUlTOGV7NkApWe53mxG8v9cMxFAzPEwB1q3/oIglhXXsXpX23yGKE7VnZzQp1syB6izPJE9ARJY7Ju924IWUEFYszVchxMJ3yi/Fdnc1a7cHRmHKjtngq/s0/LT6m9J/gwiGX57uknj9SY7yDPBCnnDIFQwTgDFMY3j7LAYvDp+tlU/4mWRikYFHYbrOGaBMSucNuYGLwQBKIeUGZ9PGGGQ52nQvLAnC0T1YkwVTA6nW9QytYPS9UE705SLe88FEUww+44M/yIMRqwFGccqXp/xQxR6vKcz5sdyDnMke8hwhZXBV6zxnKwkPZUjmkNE176I28KWKMoxd1V6WQeGMpS3ZDQhPGoEMxHg7dqkVX5ByvUE6V5OuVih+ngwB/J1fICCNN5rtSyL8GlGS/QVoDJk0ZAQJj25iYOt8hHFIMBHKpiQVIzGSyZUYztS2j4QxMlcCSndsB924Irjmf9w54fBzMAj44Ya87ZRt/ie6UxaSNGeUx5MYA3JZl1BIe5ys9VGvay219Y6UtjVlPU3Zb3+8TdsNC0Gp7ZtlG1Zkq150hLt9hjc4S1AUwfQkPdzDeuwI4J3T/77mf97drP8V5Iq+13kGpiiN74stRxWBgnMJtKq/YIJzChZ0AoVVTTuAwpFpFI5OVLbxCxFGSI3XPAcDuzh4pTmfIcZP3XIUnkUTW9A37tHXDvomptE3uSj0je1Cn0o/7Hg/gvmUoowhkl4WAWuksYWAjj5d/3PB2fCSTheUufCH78xcuOPWFOvGfN3O1IX/4l3LeO7C0WfsHzx54Vg2a3f0afulpy/qJLLmFtbP4tsCovEMhnNZ83jHsom8q0/kLzCJUaeKLQB09eeQPQCbAaDxPIaS8kIAWPdzzBgA9aeJjyRaXxb/XvmNbJ5/eg6j518z/HNc4wA8Nd3RMQDW6GEMgHpGYkboHNTXNX1MBNbIYgsCvX4K2BoCA9MI9KybA+4mnIaNX2yeZZNAT58EgjRfQmo7A83IZA0T+2lha0wcG2eiddPCli82y+aFnj4vpBDz2IO/IsCsTxCaEcsaMuoPuXoyNkPG7as35sh46uOwrpHxyjIy6o+s4CpDFIiamh6OtXrZAkdV4dPDsXk4Hls91Z64ep7kzqYCm+YvN394WBJjrwfpyQwoLoRf3SqzOZ9Q1nBRz4I8LB7nKM/7WtHN2pGqlnnzW66T1jTrRgrEylrRIt7trRX19QzIB68V9S3Lgfh6DqRbN7Hma0XrJLLmJtZnPtoCovFaUd+6xEerlQK+ZXkP/0DeYw4Qth2I51HFFgCqnfUAbByAxmtFg1OLQLoFwMCyzEagZza6USZwHlmsIaCex+gJ2AwBzVeLBqcmPDqGwBo9jCFQz0lMCaXi04KXxcAaXaxh4KlfBuoZWMtA4+WigZ7j+ODPuIpwtgiDeibiSX5U4+Ifc9VpZQ0aj3jjGKbRb+LruLw1xSDP0ZS7JGFzLG/ycIXYD3X/58s/xfLnQLZuVjurbtaqkfKj/6EGEI2drUSz3GzT2m4XxVCpxXmXkJikAN+WVqmV6FerlDTlZEGn8CX2Sa8zhfq6ju6rF+QhUZWNQgwYet4/3kNKyz18E/eFMobcq/0HcUH1+VpxnnKrMl60gTy3MpBfGajwgzbQJvC2p/3+WFQp1T4WX5jDvBqLR3xipMVgHFW+IDSqkuvYYBwFlWCsfmHo3cHIm+WHtIvu5dfIvdv/AQ==</diagram></mxfile>

‎assets/codechallenges_schema.png

27.2 KB
Loading

‎assets/core_logo.png

49.5 KB
Loading

‎assets/resources_schema.drawio

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<mxfile host="app.diagrams.net" modified="2021-02-15T05:06:27.621Z" agent="5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.150 Safari/537.36" etag="_uoZIOl08-_IwOyfrQi0" version="14.2.7" type="device"><diagram id="O3KLrP1naxKt7Erf4wuU" name="Page-1">7Z1db+I4FIZ/DZczIp/Qyy1tZ6XtSFW72p29GrnEBK9CzDhmCvPr1yY2AVy3dEnqkyYSquKD4yTntZ8457hhEEwW6y8MLedfaYKzgT9M1oPgauD7F2Es/krDpjRE44vSkDKSlCavMjyQX1gZh8q6IgkuDipySjNOlofGKc1zPOUHNsQYfTqsNqPZ4VGXKMWG4WGKMtP6N0n4vLSO/VFl/x2TdK6P7MXq+hZIV1ZXUsxRQp/2TMH1IJgwSnm5tVhPcCZ9p/1S7ndj+XZ3Ygzn/JQdvvo/hp/WfzH2b5TgyZcfN/N080m18hNlK3XB97igKzbFd9Ix5YnzjfaGuIal3OToUZouC44YV6IFQ2EQMnBEcsyEwduWswwtC7KtXlrmJEtu0YauuG5Ily5nZI2T+1IzWVfIdysak0XZ+Ew0/qBORn6NMpLmYnsqPCCPeMlwIc7lFhVc1VBXhxnHa6vbvJ0YohNjusCcbUQVvUOo9FMd2Nflp6o7eGNlm+93hUAZkeqC6a7tSiWxoYR6g2i+IZpVKHGdnKDsXgwNlKdbzQ4lkX5NGF3+iViKuTIsKZEevf4pfLRzPsmyCc2oVDanuWyJ06X6MsMzve8j5ZwutIDKHbtGt66ILsVHOGcy/BwNInG6E1H2qrL4yOqMT2hecCb6k2wDC1mfsJT2NFnt/d3UWmkbnChtY8oGhrJ3f7xN2y0FUaXtm2UbHsl2POiocPss24JsTpIE52fp4T+vx54AwXv6PzT8L6q79b+GXFn3sliiKcnT23LP+Eig6L0EWtsHTPSegkWtQOGxpi1AYewahfGZytY+EHFCdHv1czCCxcGR4XxOeGafDwJB4btoAgV94x59zaDvwjX6LjqFvjEs9OnAw573E1xMGVlyQvNuEdAiDRQCeuZ0fT968SCc/5JkHQpihMP/GcTYRa/qF68dU3eYUYzwxRuY8zCGZ07eP3gcwwM2gffMGXzXIxk2icDczfoJfVNAdB7M8Lo1pfeAzel9c07fwXiGTRUoAPTNZGQPwHoA6DykoaXsCABtj2POAGgmFh9psukW/155RnbPPzOc0fOvHv55vnMAnhvuaBkALXo4A6AZkaAswaxjBLSoAoWAQT8DbIyAkWsCBuCmgPvxpmHtgy0ANgcMzDlgwRFfFdAZ6EYmKEwMzdhFz8SamDh2zcTQvOHdQEqU1D/cwuHzkjhb8WneleSa/u/typa8n05gsGjezXTu3ypchxL+sU55vDXhH3iNKdaO8AbIhH/Z2+Em/EMzuvHBE/4hsABHaAY42nULqz/hb5MIzC3MXKMBEYggZ/avANF5wj88dzFHu8K9ZVcGRENzvUUHE/42VaAAUB+sB2DtAHSe8I/ODeW3C4ARsLBGZIY1OvtfDDZtwGDQDGX0GKwHg+7z/tG5UY+WcdCihzMOmoGJFcs6xj+LJlD4F/dZ/8b45zzrH5sTEcejr9m8SQws6x+bk4sZXeXJ9wRx8I/DbqQCw8V2JExayUXnmf8Y3HrQhgcbsHxJ/NyC0BTl5BdqwxOyG7HAkLHPnDRFxt2LN92REVzqpOHBBix3Epu5k1YslXejEhQkjvpcSmNIPHntVGPigkumNDvYRsCyKSMziNEvnbfLBIWJ0bnvkOyZaGXiyDUTI/MZ4IMvnS+7MxwqRuZEvShfudb51fM2qcCQ8YT30eA8+U3+gIIoTTNUFGQqXDLnC3GgbeIQrwn/prwnt/+R258jVbpa7311tdGFXJz9N92ALOztJYvVbtvSbr8kxVotgbs5TWmOsuvKqrSS9axKKZP6J4EX0Ke8zjXpbRX9V8fjc6JqG8MZ4uTn4fk+p7Q6wp28LVR9aEdg/cMaF0edRb0Isdyr6i9GQ4F/1FB41FDpB6OhbcfbXfYZz5snPLl0ti/qKcyrffGEF9A12Bnjo/dLxsfkOrUzxtFRZxzX1RlFsfqtlbJ69YM1wfV/</diagram></mxfile>

‎assets/resources_schema.png

26.5 KB
Loading

‎codechallenges/models.py

-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
from django.db import models
22

3-
# Create your models here.
4-
53
class CodeChallengeEvent(models.Model):
64
title = models.CharField(max_length=150)
75
description = models.TextField()

‎readme.md

+102-7
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,111 @@
1-
Run Server
1+
<img src="/assets/core_logo.png" width="400px">
22

3-
python manage.py runserver
3+
**Core is the central application that powers many of our online services and events.**
44

5-
Make migrations
5+
<hr>
66

7-
python manage.py makemigrations PROJECTNAMEHERE
7+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/CarletonComputerScienceSociety/Core/blob/master/License)
8+
9+
<hr>
10+
11+
## Table of Contents
12+
- [Context](#context)
13+
- [Setup](#setup)
14+
- [Local](#local)
15+
- [Docker](#docker)
16+
- [Applications](#applications)
17+
- [Code Challenges](#code-challenges)
18+
- [Resources](#resources)
19+
- [Commands](#commands)
20+
21+
## Context
22+
23+
Core is a Django based application. We choose Django to build out this application because of Django's "app based" structure and Django's preconfigured dashboard system. The hope is that to avoid having to configure and run several microservices, we can instead create new Django apps.
24+
25+
#### Services
26+
27+
- Django (Core Application)
28+
- PostgreSQL
29+
- RabbitMQ
30+
- Celery
31+
32+
## Setup
33+
34+
Docker is recommended for application setup due to the high number of services required for this project.
35+
36+
### Local
37+
38+
If you do not have a virtual environment
39+
40+
```bash
41+
virtualenv venv -p python3
42+
```
43+
44+
Activate virtual environment
45+
46+
```bash
47+
source venv/bin/activate
48+
```
49+
50+
Deactivate virtual environment
51+
52+
```bash
53+
deactivate
54+
```
55+
56+
Start Rabbitmq
857

9-
Migrate
58+
```bash
59+
rabbitmq-server
60+
```
1061

62+
Start Celery Worker
63+
64+
```bash
65+
celery -A core worker -l info
66+
```
67+
68+
Setup Django Application
69+
70+
```bash
1171
python manage.py migrate
72+
python manage.py runserver 0.0.0.0:8000
73+
```
74+
75+
### Docker
76+
77+
```bash
78+
docker-compose up
79+
```
80+
81+
## Applications
82+
83+
### Code Challenges
84+
85+
The Code Challenges app is used to manage code challenge events.
86+
87+
<br>
1288

13-
mhei2ojmkd923eu8i
89+
<img src="/assets/codechallenges_schema.png" width="800px">
90+
91+
### Resources
92+
93+
The Resources app controls the dynamic content on the CCSS website. This app was created so volunteers could easily populate the website with resources, links, jobs postings and more.
94+
95+
<br>
96+
97+
<img src="/assets/resources_schema.png" width="800px">
98+
99+
## Commands
100+
101+
Make migrations
102+
103+
```bash
104+
python manage.py makemigrations PROJECTNAMEHERE
105+
```
14106

107+
Create superuser in docker
15108

16-
docker exec -it f9e0818d9d28 python manage.py createsuperuser
109+
```bash
110+
docker exec -it DOCKERCONTAINERID python manage.py createsuperuser
111+
```

0 commit comments

Comments
 (0)