Skip to content

Commit 7692836

Browse files
committed
Update README.md
1 parent d8f9d3b commit 7692836

File tree

2 files changed

+61
-15
lines changed

2 files changed

+61
-15
lines changed

README.md

Lines changed: 55 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -41,30 +41,70 @@ ALL CONTENTS IN THIS REPO ARE FOR EDUCATIONAL PURPOSES ONLY.
4141

4242
### Dependencies
4343

44-
* Flask==3.0.0
45-
* Werkzeug==3.0.1
44+
* See `requirements.txt`
4645

47-
### Usage
46+
### Installation
47+
48+
1. **Clone the repository:**
49+
50+
```bash
51+
git clone https://github.com/ggeerraarrdd/lafs-cms.git
52+
```
53+
54+
2. **Navigate into the project directory:**
55+
56+
```bash
57+
cd lafs-cms # For example
58+
```
59+
60+
3. **Create and activate a virtual environment:**
61+
62+
```bash
63+
python -m venv venv
64+
source venv/bin/activate # On Windows use `venv\Scripts\activate`
65+
```
66+
67+
4. **Install the dependencies:**
68+
69+
```bash
70+
pip install -r requirements.txt
71+
```
4872

49-
Clone it!
73+
5. **Create an `.env` file and set the environment variables:**
5074

51-
```bash
52-
git clone https://github.com/ggeerraarrdd/lafs-cms.git
53-
```
75+
Create a file named `.env` in the `app` directory of the project and add the following variables:
76+
77+
```properties
78+
SECRET_KEY=your_secret_key
79+
MAP_API_KEY=your_map_api_key
80+
DATABASE_NAME="lafs.db"
81+
```
82+
83+
Replace `your_secret_key` (see #6 below) and `your_map_api_key` (see # 7 below) with your actual secret key and API key.
84+
85+
6. **Notes on Flask Secret Keys:**
86+
87+
TODO
88+
89+
7. **Notes on Google Maps API Keys:**
90+
91+
TODO
92+
93+
### Usage
5494

55-
Go into the project directory and run the command:
95+
1. **Go into the app directory and run the command:**
5696

57-
```bash
58-
flask run
59-
```
97+
```bash
98+
flask run
99+
```
60100

61-
To open the film series website, copy the URL after 'Running on'.
101+
2. **Open the film series website:**
62102

63-
To open the CMS, add `cms` at the end of the url.
103+
Copy and open the URL displayed after 'Running on' in the terminal.
64104

65-
### Notes on Google Maps
105+
3. **Access the CMS:**
66106

67-
This is disabled.
107+
Add `/cms` at the end of the URL.
68108

69109
## Author(s)
70110

docs/csv/series.csv

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
"series_id","series_semester","series_year","series_title","series_brief","series_poster","series_poster_url","series_display"
2+
1,Fall,2002,Anxious Terrains,"How landscape induces and nurtures pathologies, how pathologies foster an investigation of landscape","","1_poster_anxiousterrains.jpg",Yes
3+
2,Spring,2003,The Geography of Displacement,"Travellers in physical spaces seeking, losing, finding, passing by, encountering, entrapping, nearly missing","","2_poster_displacement.jpg",Yes
4+
3,Fall,2003,Ladscapes,How the young constitute and condition landscapes and vice versa,"","3_poster_ladscapes.jpg",Yes
5+
4,Spring,2004,Alien Nation,or: How I Learned To Stop Worrying And Learned To Live With Foreigners,"","4_poster_aliennation.jpg",Yes
6+
5,Fall,2004,Spectral Subtopia,Seven Films about Suburban Space in Post-War America,"","",Yes

0 commit comments

Comments
 (0)