awslabs/startup-kit-nodejs

Name: startup-kit-nodejs

Owner: Amazon Web Services - Labs

Owner: AWS Samples

Description: A Node.js sample workload for use with the AWS Startup Kit.

Created: 2017-01-25 19:21:53.0

Updated: 2018-01-13 18:31:17.0

Pushed: 2017-09-12 18:19:18.0

Homepage: null

Size: 40

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

AWS Startup Kit Node.js Workload

An example AWS Elastic Beanstalk project built using Node.js as the platform. It includes a RESTful API created with Express. Use this example to test out your VPC and database setup on AWS, or as a starting point for your own projects.

LAUNCHING THE APP ON AWS

To create an Elastic Beanstalk app on AWS using this code:

• Create VPC and database stacks in CloudFormation using the Startup Kit templates.
• Connect to your RDS database with a database client. Then, using the database name you provided when you created the database stack, run the command CREATE DATABASE [your- database-name] if you don't see that name in the database list. Switch to that database.
  
• Run the relevant sql script (MySQL or PostgreSQL) from the sql directory of this GitHub repository to create the actual database tables.
• At the top level of the project directory, include a config.json file. To select a database type, use 'mysql' for MySQL or 'pg' for PostgreSQL as the value for the DB_CLIENT key. To enable JWT-based token authentication to protect API routes, set the value of the AUTH_ENABLED key to true. An example file where PostgreSQL is selected as the database:
  

{
    "DB_CLIENT": "pg",
    "DB_HOST": "localhost",
    "DB_USER": "startupadmin",
    "DB_PASSWORD": "changeme",
    "DB_NAME": "StartupDB",
    "DB_MAX_CONNS": 100,
    "AWS_REGION": "us-east-1",
    "AUTH_ENABLED": false,
    "AUTH_JWT_SECRET": "my-secret",
    "AUTH_JWT_TOKENTIME":  6000
}

• Zip the code: you can do this by running the following command inside the top level directory containing the source code:

  run zip
  

  (Note: if zipping the code without this command, be sure to zip/compress the contents of the folder EXCEPT the node_modules directory. Do NOT zip the top level folder/directory itself, zip the contents only.)
• Follow the directions in Step 4, Create the app, in the README of the Startup Kit templates. Select 'node' as the stack type.

STEPS TO BUILD AND RUN LOCALLY

• Database intallation: either a MySQL or PostgreSQL database should be installed on your local computer using standard ports. MySQL can be easily installed using a package downloaded from the MySQL website. For PostgreSQL, Postgres.app is an easy option for Macs.
• Use the CREATE DATABASE command to create a new database, then switch to it and set up the database tables by running the applicable sql script (MySQL or PostgreSQL) from the sql directory of the project.
• If you haven't done so already, include a config.json file per the directions above in the section, LAUNCHING THE APP ON AWS.
• To build locally: at the command line in the top level directory, run the install command below. It relies on the included package.json file to install all necessary dependencies.

  install
  

• To run locally: first make sure your local database is running. Then execute the following command in the top level directory.

   app
  

TESTING THE APP

• To test without auth: run the following curl commands. The first fetches all items in the database, while the second adds items. When testing against an Elastic Beanstalk environment, replace localhost:8081 with the Elastic Beanstalk environment URL.

curl http://localhost:8081/api/todo/all

curl -X POST -H 'Content-Type: application/json' -d '{"active": true, "description": "What TODO next?"}' http://localhost:8081/api/todo/new

• To test with auth: if you haven't done so already, in the config.json file, set the value of the AUTH_ENABLED key to true, and either restart the app (if running locally) or redeploy. Then run the following curl commands. The first returns an access token, which should be used to replace MY_AUTH_TOKEN in the second and third API calls. These calls respectively fetch all items in the database, and add new items. When testing against an Elastic Beanstalk environment, replace localhost:8081 with the Elastic Beanstalk environment URL.

curl -X POST -H 'Content-Type: application/json' -d '{"username": "FirstUser", "password": "MyPassword"}' http://localhost:8081/api/auth

curl -H 'Authorization: Bearer MY_AUTH_TOKEN' http://localhost:8081/api/todo/all

curl -X POST -H 'Authorization: Bearer MY_AUTH_TOKEN' -H 'Content-Type: application/json' -d '{"active": true, "description": "What TODO next?"}' http://localhost:8081/api/todo/new

DEPLOYMENT NOTES

Environment variables: this app uses the nconf module to provide a hierarchy for variable overriding. For this app, the order is command line, environment variables, then lastly the local config.json file, which provides defaults for talking to a developer's local database. For the connection to a RDS database, the developer specifies relevant environment variables when creating the database stack using the db.cfn.yml CloudFormation template. These values, which are never committed to source control for security reasons, flow through to the app creation template.

To deploy a modified version of the app: set up the Elastic Beanstalk CLI, and use the eb deploy command. Alternatively, you could use a continuous delivery solution such as AWS CodePipeline.