You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
2 years ago | |
---|---|---|
lush | 2 years ago | |
tests | 2 years ago | |
.env | 2 years ago | |
.gitignore | 2 years ago | |
LICENSE | 2 years ago | |
MANIFEST.in | 2 years ago | |
README.md | 2 years ago | |
init.sh | 2 years ago | |
setup.py | 2 years ago |
README.md
lush
No bloat, no js, and no bs.
lush is a minimalist blogging platform for the common writer. It is currently in alpha, or beta as basic functionality is still being added (see in progress features and long term goals below).
Features
- lush now lets the user choose between plain text and markdown for posts
- Minimal resource utilization
- a local instance of lush loads in only 72 ms
- only uses html and css for rendering and posts are stored in a slim sqlite db
- Manage the database from the command line with commands to add users, remove users, initialize the data, and more to come
In progress features
- Following
- Bookmarks
Long term goals
- Customized themes
Install guide
Installing via wheel
Installing lush is made easy with flask.
- Dependencies to install are the python wheel package and waitress-serve.
- Run the following to install deps:
pip install wheel
pip install waitress
use whatever your OS' package manager is
sudo pacman -S waitress-serve
-
Next build the wheel distribution
python setup.py bdist_wheel
- You can find the file in dist/lush-0.1.0-py3-none-any.whl.
-
finally install with
pip install dist/lush-0.1.0-py3-none-any.whl
Setting up lush
- Environment vars will need to be set for the next step you can simply run
source init.sh
- Next we will initialize the DB by running
python3 -m flask init-db
- You will next want to generate your secret key - you may do it this way
python -c 'import secrets; print(secrets.token_hex())'
- Create the config.py file in the instance folder, and copy the generated value into it.
- Create your first user by running
python3 -m flask addusr
and following the guided steps- if you need to delete a user you can run rmusr
Configure Nginx
to-do
Running lush
the webserver can be launched with the following: waitress-serve --port=80 --call 'lush:create_app'