~sirodoht/velonica

Self-hosted personal notes web app based on Notational Velocity.
change js app structure
add favicon as png base64
add notational velocity like functionality

refs

master
browse  log 

clone

read-only
https://git.sr.ht/~sirodoht/velonica
read/write
git@git.sr.ht:~sirodoht/velonica

You can also use your local clone with git send-email.

#velonica

Self-hosted personal notes web app based on Notational Velocity.

#Contributing

Email patches to ~sirodoht/public-inbox@lists.sr.ht.

On how to contribute using email patches see git-send-email.io.

#Installation

velonica is designed to run from localhost rather than being deployed as a web service. To install and use run the following:

git clone git@git.sr.ht:~sirodoht/velonica
cd velonica
python3 -m venv venv  # create a python virtualenv
source venv/bin/activate  # activate virtualenv
pip install -r requirements.txt  # install dependencies
python manage.py migrate  # migrate database
python manage.py runserver  # run django development server

Now the web app should be up at http://127.0.0.1:8000/

#Development

This is a Django codebase. Check out the Django docs for general technical documentation.

The Django project is velonica. There is one Django app, main, with all business logic.

#Dependencies

Using venv:

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
pip install -r requirements_dev.txt

This project also uses pip-tools for dependencies management.

#Database

This project uses SQLite. It creates a db.sqlite3 database file in the project root.

To create the database schema:

python manage.py migrate

#Serve

To run the Django development server:

python manage.py runserver

#Testing

python manage.py test

#Code linting & formatting

black . && isort --profile black . && flake8

#License

This software is licensed under the MIT license. For more information, read the LICENSE file.