Development

Development environment is managed with poetry.

$ git clone https://github.com/Velocidensity/shorty
$ cd shorty
$ poetry install --with-dev

Compiling Tailwind CSS

Default frontend comes with a precompiled Tailwind file, but if you wish to change it, you can recompile it with the following commands:

$ npm install -D tailwindcss
$ npx tailwindcss -c tailwind.config.js -o shorty/static/tailwind.css --minify

Formatting JavaScript code

JavaScript code is formatted using semistandard.

Pre-commit hooks

To install pre-commit hooks, run:

$ pre-commit install

Building documentation

To build docs, install sphinx and furo theme with poetry, and then use make.

$ poetry install --with=docs
$ cd docs
$ make html