Eclectic Media Git eclecticmedia.space / master
Added a simple readme Ariana Giroux a month ago
1 changed file(s) with 40 addition(s) and 0 deletion(s). Raw diff Collapse all Expand all
0 # Intro & Install
1
2 This is the code for our under construction site (often in use at https://eclecticmedia.space/). It represents a minimum viable product (MVP) for a flask site.
3
4 This repo is licensed under the MIT license, so feel free to hack away where you see fit. If you do something interesting with it or notice a bug in the MVP included in this repo, feel free to email me a patch or git-native 'request-pull' at `ariana.giroux@gmail.com`!
5
6 ## Install/setup the dev environment
7
8 First, you'll want to set up a virtual environment:
9
10 ```
11 python3 -m venv venv
12 ```
13
14 Then, install the project requirements:
15
16 ```
17 source venv/bin/activate; pip3 install -r requirements.txt
18 ```
19
20 The style is written using sass, and can be compiled with `ruby-sass`. Check your package manager for package availability. Alternatively, `node-sass` from `npm` can compile the sass to CSS.
21
22 On Debian based distributions:
23
24 ```
25 sudo apt-get install ruby-sass
26 sass scss/style.scss static/css/style.css # compile sass to css for browser suport
27 ```
28
29 Finally, use `flask` to launch a local web server!
30
31 ```
32 flask run
33 ```
34
35 If everything goes according to plan, you should be able to point your browser at `http://127.0.0.1:5000'!
36
37 # LICENSING
38
39 See license file for more. All code exists under the MIT license, but the assets do not fall under this license!