Skip to content

A serverless todo application using lamdba, api gateway, dynamodb and serverless framework

Notifications You must be signed in to change notification settings

cchamangwana/serverless-todo-application

Repository files navigation

Serverless TODO

A simple TODO application using AWS Lambda and Serverless framework, for the final project of the Udacity Cloud Developer Nanodegree.

Functionality of the application

This application will allow creating/removing/updating/fetching TODO items. Each TODO item can optionally have an attachment image. Each user only has access to TODO items that he/she has created.

Prerequisites

Node.js and NPM

Before getting started, make sure Node.js is downloaded and installed. The latest version of Node.js can be downloaded from nodejs.org and it's recommended to use the LTS version.

Serverless Framework

Serverless Framework is used to build and deploy the application. Instructions for installing Serverless Framework can be found here.

Amazon Web Services (AWS)

An AWS account is required to deploy the application.

Auth0

Auth0 is used for authentication and an Auth0 application should be created with asymmetrically encrypted keys (RS256).

Getting started

Backend

To build and deploy the application, first edit the backend/serverless.yml file to set the appropriate AWS and Auth0 parameters, then run the following commands:

  1. cd to the backend folder: cd backend
  2. Install dependencies: npm install
  3. Build and deploy to AWS: sls deploy -v

Frontend

To run the client application, first edit the client/src/config.ts file to set the appropriate AWS and Auth0 parameters, then run the following commands:

  1. cd to the client folder: cd client
  2. Install dependencies: npm install
  3. Run the client application: npm run start

This should start a development server with the React application that will interact with the serverless TODO application.

Postman collection

A Postman collection is available in the root folder of the project, as an alternative way to test the API.

Acknowledgements

This project was bootstrapped with https://github.com/udacity/cloud-developer/tree/master/course-04/project/c4-final-project-starter-code.

About

A serverless todo application using lamdba, api gateway, dynamodb and serverless framework

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published