GithubHelp home page GithubHelp logo

cchamangwana / serverless-todo-application Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 538 KB

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

JavaScript 8.58% TypeScript 85.98% HTML 3.52% CSS 1.92%

serverless-todo-application's Introduction

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.

serverless-todo-application's People

Contributors

cchamangwana avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.