Skip to content

Commit 56ff217

Browse files
committed
Add project structure diagram
1 parent eac6157 commit 56ff217

File tree

1 file changed

+30
-2
lines changed

1 file changed

+30
-2
lines changed

README.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ A bespoke CMS for the Landscape Architecture Film Series website
44

55
## Description
66

7-
_LAFSCMS_ is the companion content management system (CMS) for the _Landscape Architecture Film Series_ [website](https://l-a-f-s.org/). Currently in alpha, the plan is to merge the beta version with the [film series repo](https://github.com/ggeerraarrdd/film-series).
7+
_LAFSCMS_ is the companion Content Management System (CMS) for the _Landscape Architecture Film Series_ [website](https://l-a-f-s.org/). Currently in alpha, the plan is to merge the beta version with the [film series repo](https://github.com/ggeerraarrdd/film-series).
88

99
Just like any real-world organization, student-run organizations such as a film series experience knowledge loss when their members graduate. Without a knowledge transfer process, this loss can lead to technical resources being underutilized or becoming inactive. While alternative resources and processes may exist, they either need to be created from scratch, requiring significant time and resources, or are imperfect substitutes. If existing resources work perfectly fine, why go through all that effort?
1010

@@ -29,14 +29,42 @@ The features of the system are based on business requirements as captured in the
2929
13. "As an admin, I want to manage users, so that their info and login credentials are correct and up-to-date.."
3030
14. "As an admin, I want to manage user privileges, so that users can access only the CMS functionalities based on their status and roles."
3131

32-
As of v2.0.0-alpha.2, all user stories have been implemented except for #1, #6, #9 and #10.
32+
As of v2.0.0-alpha.5, all user stories have been implemented except for #1, #6, #9 and #10.
3333

3434
More screenshots below.
3535

3636
## Disclaimer
3737

3838
ALL CONTENTS IN THIS REPO ARE FOR EDUCATIONAL PURPOSES ONLY.
3939

40+
## Project Structure
41+
42+
```txt
43+
lafs-cms/
44+
├── README.md
45+
├── requirements.txt
46+
├── LICENSE
47+
├── docs/
48+
└── app/
49+
├── blueprints/
50+
│ ├── main/
51+
│ │ ├── __init__.py
52+
│ │ ├── routes.py
53+
│ │ ├── static/
54+
│ │ ├── templates/
55+
│ ├── cms/
56+
│ │ ├── __init__.py
57+
│ │ ├── routes.py
58+
│ │ ├── static/
59+
│ │ ├── templates/
60+
├── crud/
61+
│ └── __init__.py
62+
├── helpers/
63+
│ └── __init__.py
64+
├── app.py
65+
└── lafs.db
66+
```
67+
4068
## Getting Started
4169

4270
### Dependencies

0 commit comments

Comments
 (0)