Skip to content

Commit 1438184

Browse files
committed
Update README.md
1 parent 9de701a commit 1438184

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

83 files changed

+28
-7022
lines changed

README.md

Lines changed: 28 additions & 163 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# LAFS-DEV
22

3-
An early aughts basic website turned modern dev playground for front-end and back-end skill-building
3+
An early aughts basic website turned modern dev playground for front-end, back-end, DevOps and system architecture skill-building
44

55
## Table of Contents
66

@@ -30,7 +30,7 @@ An early aughts basic website turned modern dev playground for front-end and bac
3030

3131
## Description
3232

33-
In the early aughts, I created a website for the _Landscape Architecture Film Series_, a student-led initiative which I co-founded and co-curated for the [Department of Landscape Architecture](https://landarch.illinois.edu/) at the University of Illinois Urbana/Champaign.
33+
In the early aughts, I created a website for the _Landscape Architecture Film Series_, a student-led initiative which I co-founded and co-curated for the [Department of Landscape Architecture](https://landarch.illinois.edu/) at the University of Illinois Urbana-Champaign.
3434

3535
Now some odd years later, I needed a website to use as a learning vehicle for back-end technical skill-building. But not wanting to spend anytime to ideate and design a new one from scratch, I turned to my old website. Its look and feel has aged well, I think, and indeed looks remarkably contemporary. For instance, if the current version of MoMA's film series [website](https://www.moma.org/calendar/film/) is anything to go by, bold color blocking isn't a dated design choice. In other words, I could focus on the back-end and spend little or no time on the front-end.
3636

@@ -40,14 +40,18 @@ Tossed into this development playground, it has so far borne out the following:
4040

4141
A GitHub repository serving as the digital coding archive of the website, transformed as a dynamic web application.
4242

43-
What would otherwise exist as slowly disintegrating bits on a forgotten CD in a remote storage facility or as [fragmented snapshots](https://web.archive.org/web/20040827234527/http://www.rehearsal.uiuc.edu/projects/filmseries/) somewhere in the depths of the Internet Archive has been meticulously restored and recreated.
43+
What would otherwise exist as slowly disintegrating bits on a forgotten CD in a remote storage facility or as [fragmented snapshots](https://web.archive.org/web/20040827234527/http://www.rehearsal.uiuc.edu/projects/filmseries/) somewhere in the depths of the Internet Archive has been meticulously restored and recreated.
4444

45-
No longer basic or static—but a dynamic web application with modern tooling such as Python, Flask, and SQLite. It even has a data model to speak of. Its interesting to note that the original website predated almost all of the technology used.
45+
No longer basic or static—but a dynamic web application with modern tooling such as Python, Flask, and SQLite. It even has a data model to speak of. It's interesting to note that the original website predated almost all of the technology used.
4646

4747
* [**l-a-f-s.org**](https://l-a-f-s.org)
4848

4949
_LAFS_ but live online!
5050

51+
* [**_LAFS-AWS_**](https://l-a-f-s.org)
52+
53+
_LAFS_ but live online!
54+
5155
* [**_LAFSCMS_**](https://github.com/ggeerraarrdd/lafs-dev)
5256

5357
A companion Content Management System (CMS) for the web application (this repository; separate repo coming soon).
@@ -58,182 +62,48 @@ Tossed into this development playground, it has so far borne out the following:
5862

5963
What else might be concocted out from a decades-old website? Stay tuned!
6064

61-
![Craftsman by Utagawa Kunisada](docs/images/craftsman_kunisada.png)
65+
![Craftsman by Utagawa Kunisada](assets/craftsman_kunisada.png)
66+
67+
> [!NOTE]
68+
> The following sections are for the overall _LAFS-DEV_ project. For information specific to individual _LAFS-DEV_ projects, check out their respective repositories.
6269
6370
## Target Users
6471

65-
* TBD
72+
* TODO
6673

6774
## Features
6875

69-
* TBD
76+
* TODO
7077

7178
## Project Structure
7279

73-
```txt
74-
lafs-dev/
75-
76-
├── app/
77-
│ │
78-
│ ├── blueprints/
79-
│ │ │
80-
│ │ ├── cms/
81-
│ │ │ ├── __init__.py
82-
│ │ │ ├── routes.py
83-
│ │ │ ├── static/
84-
│ │ │ └── templates/
85-
│ │ │
86-
│ │ └── main/
87-
│ │ ├── __init__.py
88-
│ │ ├── routes.py
89-
│ │ ├── static/
90-
│ │ └── templates/
91-
│ │
92-
│ ├── config/
93-
│ │ └── __init__.py
94-
│ │
95-
│ ├── crud/
96-
│ │ └── __init__.py
97-
│ │
98-
│ ├── data/
99-
│ │ └── lafs.db
100-
│ │
101-
│ ├── infra/
102-
│ │ └── __init__.py
103-
│ │
104-
│ ├── utils/
105-
│ │ └── __init__.py
106-
│ │
107-
│ └── app.py
108-
109-
├── logs/
110-
111-
├── docs/
112-
├── .gitignore
113-
├── LICENSE
114-
├── README.md
115-
└── requirements.txt
116-
```
80+
* NA
11781

11882
## Prerequisites
11983

120-
* TBD
84+
* NA
12185

12286
## Getting Started
12387

12488
### Dependencies
12589

126-
* See `requirements.txt`
90+
* NA
12791

12892
### Installation
12993

130-
1. **Clone the repository**
131-
132-
```bash
133-
git clone https://github.com/ggeerraarrdd/lafs-dev.git
134-
```
135-
136-
2. **Set up a Python virtual environment**
137-
138-
```bash
139-
python3 -m venv venv
140-
source venv/bin/activate # On Windows use `venv\Scripts\activate`
141-
```
142-
143-
3. **Install the dependencies**
144-
145-
```bash
146-
pip install --upgrade pip
147-
pip install -r requirements.txt
148-
```
94+
* NA
14995

15096
### Configuration
15197

152-
1. **Create an `.env` file**
153-
154-
Place the file in the root directory and add the following as default:
155-
156-
```python
157-
# Database Path
158-
DATABASE_NAME='data/lafs.db'
159-
160-
# Database Connection Pool
161-
POOL_SIZE=5
162-
MAX_OVERFLOW=10
163-
POOL_TIMEOUT=30
164-
POOL_RECYCLE=-1
165-
ECHO=False
166-
167-
# Database Retry Settings
168-
MAX_RETRIES=3
169-
BASE_DELAY=1
170-
MAX_DELAY=10
171-
172-
# Flask Secret Key
173-
SECRET_KEY='your_flask_secret_key'
174-
175-
# Google Maps API Key
176-
MAP_API_KEY='your_map_api_key'
177-
```
178-
179-
2. **Database**
180-
181-
```python
182-
# Database Path
183-
DATABASE_NAME='data/lafs.db' # Path to SQLite database file
184-
185-
# Database Connection Pool
186-
POOL_SIZE=15 # Max number of persistent connections
187-
MAX_OVERFLOW=5 # Max number of connections above POOL_SIZE
188-
POOL_TIMEOUT=30 # Seconds to wait for available connection
189-
POOL_RECYCLE=1800 # Seconds before connection is recycled
190-
ECHO=False # Enable SQLAlchemy engine logging
191-
192-
# Database Retry Settings
193-
MAX_RETRIES=3 # Max retry attempts for failed operations
194-
BASE_DELAY=1 # Initial delay between retries in seconds
195-
MAX_DELAY=10 # Max delay between retries in seconds
196-
```
197-
198-
3. **Flask Secret Key**
199-
200-
```python
201-
# Flask Secret Key
202-
SECRET_KEY='your_flask_secret_key'
203-
```
204-
205-
4. **Google Maps API Key**
206-
207-
```python
208-
# Google Maps API Key
209-
MAP_API_KEY='your_map_api_key'
210-
```
211-
212-
An API Key is needed for the embedded map to work. Before you can create one, you will need to create a Google Cloud project, for which you need a Google Cloud account.
213-
214-
* [Set up a Google Cloud account](https://cloud.google.com)
215-
* [Set up your Google Cloud project](https://developers.google.com/maps/documentation/javascript/cloud-setup)
216-
* [Using API Keys](https://developers.google.com/maps/documentation/javascript/get-api-key)
98+
* NA
21799

218100
## Usage
219101

220-
1. **Go into the app directory and run the command**
221-
222-
```bash
223-
flask run
224-
```
225-
226-
2. **Open the film series website**
227-
228-
Copy and open the URL displayed after 'Running on' in the terminal.
229-
230-
3. **Access the CMS**
231-
232-
Add `/cms` at the end of the URL.
102+
* NA
233103

234104
## System Administration
235105

236-
* TBD
106+
* NA
237107

238108
## Author(s)
239109

@@ -243,38 +113,33 @@ lafs-dev/
243113

244114
### Release Notes
245115

246-
* See [https://github.com/ggeerraarrdd/lafs-cms/releases](https://github.com/ggeerraarrdd/lafs-cms/releases)
116+
* See [https://github.com/ggeerraarrdd/lafs-dev/releases](https://github.com/ggeerraarrdd/lafs-dev/releases)
247117

248118
### Initial Release
249119

250-
* TBD
120+
* NA
251121

252122
## Future Work
253123

254-
* TBD
124+
* TODO
255125

256126
## License
257127

258128
* [MIT License](https://github.com/ggeerraarrdd/large-parks/blob/main/LICENSE)
259129

260130
## Contributing
261131

262-
* TBD
132+
* This project is not accepting contributions at this time. It is intended solely for personal learning and exploration. However, feel free to clone the repository and use it as a learning resource.
263133

264134
## Acknowledgments
265135

266136
* Coeus
267137

268138
## Screenshots
269139

270-
![LAFSCMS](docs/images/lafscms_1.png)
271-
![LAFSCMS](docs/images/lafscms_2.png)
272-
![LAFSCMS](docs/images/lafscms_3.png)
273-
![LAFSCMS](docs/images/lafscms_4.png)
274-
![LAFSCMS](docs/images/lafscms_5.png)
275-
![LAFSCMS](docs/images/lafscms_6.png)
276-
![LAFSCMS](docs/images/lafscms_7.png)
140+
![LAFS](assets/film-series1_1.jpg)
141+
![LAFS-CMS](assets/lafscms_1.png)
277142

278143
## Frontispiece
279144

280-
* TBD
145+
Utagawa, Kunisada. (1858). Craftsman (Ko) [Woodblock print triptych]. From the series The Four Classes (Shinokosho). Published by Daikokuya Heikichi (Shojudo).

app/__init__.py

Whitespace-only changes.

app/app.py

Lines changed: 0 additions & 44 deletions
This file was deleted.

app/blueprints/__init__.py

Whitespace-only changes.

app/blueprints/cms/__init__.py

Lines changed: 0 additions & 8 deletions
This file was deleted.

0 commit comments

Comments
 (0)