serverless/docs/project_structure.md

JAWS: Project Structure

All JAWS apps use the directory structure described in the diagram below. This scaffolding can be generated by running the jaws new project command.

Web, mobile and IoT applications can be built on JAWS, since JAWS is mostly a back-end focused framework. JAWS comes with a front folder, but doesn't do much with it (yet).

jaws.json

See project jaws.json example here

The jaws.json file contains project configuration and authorship details.

Common jaws.json attributes

The following attributes should exist in either a project or lambda jaws.json at the top level

• name: project/module or lambda action name
• version: project/module or lambda Semantic Versioning number.
• location: project/module or lambda scm url (if exists)
• author: John Serverless <john@gmail.com> http://www.john.com
• description: project/module or lambda desc.
• stages: map of all your stages, and regions those stages are in as well as IAM roles
• jawsBuckets: map of region to bucket name for JAWS S3 bucket in the region

admin.env

This file tells the JAWS tooling what profile from the shared credentials file (~/.aws/credentials) is loaded when doing administrative tasks that interact with AWS.

Here is an example

ADMIN_AWS_PROFILE=default