Have ideas to improve npm?Join in the discussion! »

    @dawson/dawson-cli

    0.28.0 • Public • Published

    dawson

    Build Status Dependency Status Greenkeeper badge Coverage Status codecov

    dawson is a serverless web framework for Node.js on AWS (CloudFormation, CloudFront, API Gateway, Lambda).
    You can use dawson to build and deploy backend code and infrastructure for single-page apps + API, pure APIs or server-rendered pages.

    npm package

    // api.js
     
    import pug from 'pug';
    const template = pug.compileFile('template.pug');
     
    export async function greet (event) {
        const name = event.params.path.name
        const age = await getUserAge(name);
        return template({ name, age });
    }
    greet.api = {
        path: 'greet/{name}'
    }
    $ npm install -g dawson
    export AWS_REGION=... AWS_ACCESS_KEY_ID=... AWS_SECRET_ACCESS_KEY=...
    $ dawson deploy

    Documentation

    Getting Started Guide, API & CLI Documentation

    Examples

    Examples & Reference Apps

    About

    dawson lets you to deploy your serverless Node.js apps on Amazon Web Services. It requires no boilerplate, no init command and no configuration files. Just write your functions and deploy!

    You can write your functions using the latest JavaScript version (babel-preset-latest), including async-await, object-rest-spread etc. Functions can be async and can return Promises. There's also built-in authorization support via API Gateway Custom Authorizers.

    Each function has its own IAM Execution Role, so you can define fine-graned IAM Policies.
    dawson offers first-class support for Single Page Applications: a CloudFront Distribution will be deployed in front of your app, correctly mapping assets and the API origin, so you don't have to worry about CORS. An AWS WAF WebACL can also be attached to CloudFront.

    dawson does not bundle your app with webpack, browserify or rollup, so you'll never have to deal with weird things. Your app's devDependencies are stripped out while deploying, keeping the bundle ZIP small.

    dawson uses pure CloudFormation templates, following the infrastructure-as-code principle; it requires no local or remote state files which may go out-of-sync or mistakenly be deleted. You can customize your app's template in every part, e.g.: you can add CloudFormation Resources, modify Properties of Resources created by dawson etc. As a free benefit, you get out-of-the-box support for multiple stages and regions.

    Finally, dawson will automatically support HTTPS for custom domains thanks to AWS ACM. Also, if you use Route53 your DNS Zone can be automatically updated.

    CLI

    Using the dawson command you can deploy the infrastructure, inspect logs (in real time, like tail -f) and spin up a full development server so you can run your all locally in an environment will be almost identical to production's. The development server can also run functions locally in response to real AWS Events (S3 Events, DynamoDB Triggers etc.).

    $ dawson deploy # deploy your app 
    $ dawson log -f functionName --follow # get function logs 
    $ dawson describe # list CloudFormation outputs 
    $ dawson dev # start a development server 

    Architecture

    https://raw.githubusercontent.com/dawson-org/dawson-cli/images/architecture.png

    (additionally for each region you'll deploy to, dawson uses a support stack with an S3 Bucket to store Lambda ZIP bundles and CloudFormation templates)

    Changelog

    A changelog is maintained in the Releases page.

    Contributing

    js-semistandard-style Commitizen friendly

    Any contribution is very welcome! You may pick an Issue, fork and start working on that. Should you need any guidance or help please ask :)

    Testing

    Run npm test.

    codecov
    We are currently testing and targeting 100% coverage for functions that are involved in the template generation (src/factories/**.js).

    Contributors

    Thanks goes to these wonderful people (emoji key):


    Simone Lusenti

    💬 📝 🐛 💻 📖 💡 🚇 🔌 👀 📢 ⚠️ 🔧 ✅

    Alex Casalboni

    💬 🐛 💻 💡 📢 ⚠️ 🔧

    Giacomo Consonni

    💻 📖 🔌

    Luca Casartelli

    💻 📖

    Chris Matheson

    🐛 📖

    Robert Kistner

    🐛 💻

    This project follows the all-contributors specification. Contributions of any kind welcome!

    Support

    In case you have an issue, make sure you have updated to the latest version (e.g.: npm i dawson@latest), then:

    • search / post on StackOverflow using the dawson tag
    • search / open an issue in this repo
    • contact me on Twitter @Lanzone31

    Related

    License

    Copyright (C) 2016  Simone Lusenti
    
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
    
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
    
    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
    

    Keywords

    none

    Install

    npm i @dawson/dawson-cli

    DownloadsWeekly Downloads

    1

    Version

    0.28.0

    License

    GPL-3.0

    Last publish

    Collaborators

    • avatar
    • avatar