Giter VIP home page Giter VIP logo

snektools's Introduction

snektools

snek's logo

Collection of tools for Snek - A simple and minimalistic static-site generator for Python.


Summary


Installing the complete snektools suite

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.

☝️ Back to summary


snekinit

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.

☝️ Back to summary


snekserve

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.

☝️ Back to summary


sneklifycms

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.

☝️ Back to summary


snektools's People

Contributors

matteocargnelutti avatar

Watchers

 avatar

snektools's Issues

Add live reload tool

Either

  • Make snekserve.sh trigger a rebuild when a file is changed, instead of in a 5 seconds loop.
  • Add a snekliverload.sh that builds, serves the website, and rebuilds / forces reload when a file is edited

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.