serverless-notes-app

A CRUD Notes REST API built on the AWS Lambda service.

Features

This simple application allows users to do the following;

1. Login via auth0
2. Create a note
3. View all the notes belonging to the current user
4. Update notes belonging to the current user
5. Delete notes belonging to the current user

Dependencies

This is a cloud application that primarily relies on AWS for functionality and Auh0 for login. Below is a comprehensive list of services in use;

1. AWS Lambda
2. Dynamo DB
3. Auth0

Installation and local setup

1. Navigate to your projects directory on terminal.

2. Clone this repository.

   git clone [email protected]:lewisemm/serverless-notes-app.git

3. Navigate to the downloaded repository.

   cd serverless-notes-app/

4. Install serverless package globally.

   npm install -g serverless

5. Install the application's dependencies

   npm install package.json

6. Start the DynamoDb service in the background on your local machine

   sls dynamodb start &

7. Start the application locally

   sls offline

Deploying to AWS

1. Login to AWS
2. Navigate to the Identity and Access Management (IAM) service
3. Add an IAM user using the console option. i. select the programmatic access option. You will get an access key and secret id. Use these to configure serverless framework ii. for permissions, add administrator access.

This is obviously a security risk, but it will do for such a hobby application. APPS ON PRODUCTION WILL REQUIRE THE USE OF LEAST PRIVILEGE PERMISSIONS.

4. Run the following command to configure serverless credentials.

aws configure

5. Provide the access key and secret id from step (3) above. Leave the rest of the options as default unless otherwise desired.
6. Run the following command to deploy.

sls deploy -v