You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Starbeamrainbowlabs 4979c04bee
Update dependencies
1 month ago
Client Fix resolution logic & tree-shaking 3 months ago
Server Use default exports & imports to try to avoid tree-shaking issues 3 months ago
Shared Use default exports & imports to try to avoid tree-shaking issues 3 months ago
lantern-build-engine @ 617fcdb5b9 Start setting up for CI 3 months ago
.gitignore Start setting up for CI 3 months ago
.gitmodules Start setting up for CI 3 months ago
.npmignore Don't bundle _everything_ in the npm package - only the essentials 2 months ago
.tern-project Import from Nibriboard-Panel 3 months ago
Client.mjs Fix resolution logic & tree-shaking 3 months ago
LICENSE Initial commit 3 months ago
README.md Add contributing section to README 2 months ago
Server.mjs Fix resolution logic & tree-shaking 3 months ago
build Alter git remote url when rendering docs to fix github urls 3 months ago
docs.css Change placeholder text colour 3 months ago
index.mjs Add logo & licence 3 months ago
logo-large.png Fix resolution logic & tree-shaking 3 months ago
logo.piskel Add logo & licence 3 months ago
logo.png Fix resolution logic & tree-shaking 3 months ago
package-lock.json Update dependencies 1 month ago
package.json Update dependencies 1 month ago

README.md

powahroot

Client and server-side routing micro frameworks

Powahroot is a pair of micro routing frameworks, presented as an ES6 module:

  • The first is for client-side single-page web applications
  • The other is for handling server-side Node.js requests

It’s based on rill (see the npm package bearing the name), but stripped down and simplified.

Getting Started

Install powahroot as a dependency with npm:

npm install --save powahroot

If your build process supports tree-shaking, only the router(s?) you need will be included in the final output of your build - as powahroot uses ES6 modules.

Usage

Paths

Powahroot supports multiple syntax bells and whistles when defining routes. These are documented below:

Syntax Meaning
/index.html Regular route. Matches exactly what it says on the tin.
* Special key(word?) that matches any route. Must be present on its own without any other characters.
/add/vegetable/:name/:weight Parameters. Match values an pull them into an object automatically. Does not like forward slashes in parameter values.
/images/::path Parameter values with forward slashes. If you want to use parameters, but need values to be able to contain forward slashes /, this is for you. Don’t forget you can mix-and-match this with the previous example!

Client

Initialise a new router like this:

import ClientRouter from 'powahroot/Client.mjs';

// ....

const router = new ClientRouter({
	// Options object. Default settings:
	verbose: false, // Whether to be verbose in console.log() messages
	listen_pushstate: true, // Whether to react to browser pushstate events (excluding those generated by powahroot itself, because that would cause an infinite loop :P)
});

Server

The server router works slightly differently, to account for the different environment it’s designed for. Here’s how to use it:

import ServerRouter from 'powahroot/Server.mjs';

// ....

const router = new ServerRouter();
router.on_all(async (context, next) => { console.debug(context.url); await next()})
router.get("/files/::filepath", (context, _next) => context.send.plain(200, `You requested ${context.params.filepath}`));
// .....

The context argument there is of type RouterContext. Check out the API reference (link below) to learn about the other useful properties it has.

Reference

API docs are generated automatically. View them here:

https://starbeamrainbowlabs.com/code/powahroot/docs/

Contributing

Contributions are welcome! Simply fork this repository, make your changes, and submit a Pull Request (issues are welcome too!).

All contributions must be declared to have the Mozilla Public License 2.0 (the same license that this repository is under).

Licence

Everything in this repository except the logo is licenced under the _Mozilla Public License 2.0.

The logo itself is © Copyright Starbeamrainbowlabs 2019. All rights reserved - though you may use it when linking to this project (or to advertise usage in a ‘powered by’ logo).