https://github.com/k-koech/todo_udacity

https://github.com/k-koech/todo_udacity

auth0 aws-cloudformation aws-lambda nodejs reactjs serverless-framework

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/k-koech/todo_udacity
• Owner: k-koech
• Created: 2022-08-28T09:26:11.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-08-28T20:39:16.000Z (over 2 years ago)
• Last Synced: 2024-11-05T23:41:29.783Z (3 months ago)
• Topics: auth0, aws-cloudformation, aws-lambda, nodejs, reactjs, serverless-framework
• Language: TypeScript
• Homepage:
• Size: 1.5 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Serverless TODO

### Kelvin Kipchumba Koech

### [email protected] / +254725 801 772

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](https://nodejs.com/en/download) 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](https://serverless.com/framework/docs/getting-started/).

### 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](https://github.com/udacity/cloud-developer/tree/master/course-04/project/c4-final-project-starter-code).