Collection of tools for Snek - A simple and minimalistic static-site generator for Python.
You will need the following on your machine:
- An UNIX-like OS (Linux, MacOS, etc ...)
- Curl (Mac users can install it via brew.sh
- Python 3.7.3+ recommended
- pipenv
From your project's folder, run the following command to add the snektools
to your project and add project boilerplate:
curl https://raw.githubusercontent.com/matteocargnelutti/snektools/master/snektools.sh > snektools.sh && chmod a+x snektools.sh && ./snektools.sh
This will copy snekinit.sh
, snekserve.sh
, sneklifycms.sh
and run the restsnekinit.sh
, which will create a basic Snek
project.
All scripts can be installed separately (see documentation below).
See Snek's documentation for more details on where to go from here.
Installs snek-framework
in a pipenv
environment and initializes a basic Snek project structure.
Run it using:
./snekinit.sh
If need be, install it using:
curl https://raw.githubusercontent.com/matteocargnelutti/snektools/master/snekinit.sh > snekinit.sh && chmod a+x snekinit.sh;
If you installed snekinit
using snektools.sh
, the file will delete itself after execution.
Ultra minimalistic script to serve your current ./build
folder over HTTP with live-reload.
Run it using:
./snekserve.sh
If need be, install it using:
curl https://raw.githubusercontent.com/matteocargnelutti/snektools/master/snekserve.sh > snekserve.sh && pipenv install livereload && chmod a+x snekserve.sh;
Your website will be accessible through this url: http://localhost:8081
.
Adds basic configuration files to allow a website to be edited with Netlify CMS.
Run it using:
./sneklifycms.sh
If need be, install it using:
curl https://raw.githubusercontent.com/matteocargnelutti/snektools/master/sneklifycms.sh > sneklifycms.sh && chmod a+x sneklifycms.sh;
See Snek's documentation for more details on where to go from here.