polka

README

Totally experimental still - use at your own risk :-)

• Quick Start
• Examples
• Setup
• Polka Commands

The following is getting dangerously close to actually working_ This is README driven development, e.g. write how you want the readme to work first, then implement the code.

Quick Start

This does not work yet...

$ brew tap INSERT_TAP
$ brew install polka
$ cd ~/code
$ polka new todo_app
$ cd todo_app
$ ???

Examples

Setup

What needs to be setup for polka to work?

• AWS Services
• AWS IAM users/roles/policies

AWS Credentials

Currently, polka assumes your AWS credentials are configured. E.g., it assumes:

• Your credentials exist at ~/.aws/credentials ( See this AWS blog post on setting up your credentials )

Polka Commands

$ polka

usage: polka [--version] [--help] <command> [<args>]

Available commands are:
    config      configure a global polka app item
    deploy      deploys a polka app to AWS
    doc         Generates documentation for your polka app
    generate    generates lambda functions for endpoints
    new         creates a new polka app
    version     Prints the Polka version

Documentation

Overview

Package main provides the entry point for the polka web application generator.