Thomasorus / Kantan

Kantan 簡単 - A bash script to launch a web server, watch files and launch build commands

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Kantan 簡単

Kantan 簡単 (simple, easy) - A bash script to launch a web server, watch files and launch build commands.

The goal is to be able to install and configure a web development environment in a few minutes with minimal dependencies.

How to install

Kantan works on Linux. To use it you need to installinotify-tools and xdotool with the package manager of your choice.

On ubuntu:

sudo apt install inotify-tools
sudo apt install xdotool 

Download the files manually or git clone in your project:

git clone git@github.com:Thomasorus/Kantan.git .

Allow the script to be executed:

chmod +x ./kantan.sh

Choose your web server

Depending on your system and your project you might have different requirements for your web server. For example you might be working on a PHP project without having NodeJS installed. To help with this, Kantan comes with several pre-configured scripts that will launch a web server in the environnement of your choice.

Available web servers:

  • Node JS
  • PHP
  • Python

By default they all serve the port 8000.

Configure Kantan

Open kantan.sh to configure it to your needs (default values are provided). You can customize these settings:

  • KEY : The key combination to refresh your browser
  • BROWSER : The browser you use (currently only supports firefox)
  • LOCATION : The folder or file you want to watch
  • SERVER_TYPE : The server type you want to use (use the ones provided or create your own!)
  • DIST : # The folder you want to serve with the server
  • BUILD : The build command you want to use (ex: npm run build)

How to use

./kantan.sh

License

Kantan 簡単 is free to use by individuals and organizations that do not operate by capitalist principles. For more information see the license file.

About

Kantan 簡単 - A bash script to launch a web server, watch files and launch build commands

License:Other


Languages

Language:JavaScript 59.5%Language:Shell 40.5%