davekelly/static-generator

Generate static HTML/JSON files from Laravel routes

Maintainers

Details

github.com/davekelly/static-generator

Source

Issues

Installs: 210

Dependents: 0

Suggesters: 0

Security: 0

Stars: 14

Watchers: 3

Forks: 4

Open Issues: 1

v0.2.0 2014-09-23 14:14 UTC

Requires

MIT ad786d3d376ee09a3e807a9b1f56b053aa04428e

htmlstaticlaravelfront-end

This package is not auto-updated.

Last update: 2024-12-17 03:40:58 UTC

README

Generate static HTML or JSON files from Laravel routes.

This was developed for use with small data visualisation-type applications where it is not required to deploy a full PHP app with a database. Instead, a front-end-only version with data held as JSON can be used. I have needed to use HTML-only versions of Laravel apps often enough that this package made sense.

Setup & Usage

Installation

  • Add 'Davekelly\StaticGenerator\StaticGeneratorServiceProvider', to the end of the providers array in /app/config/app.php
  • You will need to create a writable directory at /public/static - this is where the static files are placed

Usage

Usage is through a front-end interface. The package adds a route to /generate where you will find this interface.

If you generate a static version of a Route that returns a JSON response, the file will have a .json extension, otherwise, it will be .html.

  • Visit http://your.domain/generate to see a list of Routes registered in your application
  • Click the button next to the Route you'd like to generate a static file for
  • If successful, the .html or .json file will be stored in /public/static - you'll be shown a confirmation message with the location & file-name.

Uses

Future To-Do's / Improvements

  • Create an Artisan CLI interface
  • Look at filtered routes

Updates

v0.2 - Creates html nested directories mimicking route structure (e.g. route: /about/contact saved to /static/about/contact/index.html) - based on idea from pulkitjalan