Giter VIP home page Giter VIP logo

serverless-book-tracker-api's Introduction

Book tracker app api

AWS serverless(lambda, dynamodb) using serverless framework. Also configured dynamodb and serverless-offline for local development.

Install and run locally

For development, you need to have serverless, npm and/or yarn globally installed. I also prefer using NVM to manage my Node versions. Tested in node v14.

Step1: Install serverless framework CLI

npm install -g serverless

Step2: Configure AWS Setup AWS CLI if you have not already. you can find useful article here create and configure AWS credentials

npm install

setp3: copy .env.example to .env

cp .env.example .env

step4: start local server

# install dynamodb-local
npm run dynamodb:install

If you get the error installing local dynamodb, Please delete package-lock.json and try to install package again. For detail here is recent bug in dunamodb local

# run serverless-offline
npm run start:offline

For lint

npm run lint

Tests: Jest is used for tests Test setupEnv file is located in tests/lib/setupEnv.ts. You can change env variables as your need.

npm run test

Deploy

First, set up your AWS settings and run the following command.

Serverless framework deploy lambda, api gateway, dynamodb and other resources.

npm run deploy:prod

Further improvement

Due to time limitation and i am new to serverless, following things can be improved:

  • use middy.js for request parsing
  • set up AWS alarams for function errors
  • refactor url endpoints to /books => for post and get all, /books/{id} => for delete and update
  • setup CI/CD

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.