Bash On Boards

This is an MVC Web Framework written in bash... because why not?

Getting Started

First things first, copy the ./config/config.examples.sh to ./config/config.sh using the following command from the project root.

cp ./config/config.examples.sh ./config/config.sh

Once you have the configuration file copied from the template, adjust the values to your requirements.

To start the server you can simply run ./server.sh in a bash terminal and it starts up the application.

Building With Bash On Boards

Please note that all paths in the application are done from the server.sh root

To start building, you can create your own routes and controllers. There are a suite of console tools to help you generate boiler plate.

You can run the scripts by executing them from the root of the project. They then launch a wizard and walk you through the rest of the process.

Registering Routes

In ./http/routes.sh you can register routes to execute specific bash functions. Typically you'll bind the route to a controller method. To register new routes, add a new entry to the map in ./http/routes.sh.

The map expects the string value to be the controller action.

# Expose the route map
declare -A ROUTES_MAP

# Register routes
ROUTES_MAP[METHOD:ROUTE]="controller.helloWorld.success"