dgholz / App-Embra

embra - build a web site from parts

NAME

App::Embra - build a site from parts

See how the development is progressing at the Trello board

HOW TO USE

1. "Set up your Perl environment"

2. "Install App::Embra"

3. "Configure your site"

4. "Write content & build your site"

Set up your Perl environment

You must use version 5.10 (or higher) of Perl, and have Carton installed.

If you are using Windows, I recommend using Strawberry Perl (version 5.10 or higher). Install Carton with cpan install Carton

For Mac & Linux, you probably have Perl 5.10 or higher already installed. If not, use plenv to install a specific version. Install Carton with curl http://cpanmin.us/instal | perl - -- cpanm -l ~/perl5 Carton.

Install App::Embra

Make a directory for your site, and create a file cpanfile in that directory with this content:

requires 'App::Embra'

Then open a terminal, change to your site's directory, and run carton to install App::Embra & its dependencies.

Configure your site

Run carton exec embra init; it will create a skeleton config in embra.ini. Edit it to check that it guessed the right values (you probably want to change name at least). More documentation for the format of embra.ini is available at https://metacpan.org/pod/App::Embra::App.

Once you're finished editing embra.ini, run carton exec embra listdeps | carton exec cpanm --local-lib local --notest to install any missing dependencies.

Write content & build your site

In your site's directory, create hello.md with this content:

---
title: greetings
----
*HI THERE*

Then, from the same terminal, run carton exec embra collate. Your site's files will appear in site/; open file:///path/to/your/sites/directory/site/hello.html to view the build site.