Create-serverless-api - Create Serverless APIs with no infra configuration

Last update: Jun 7, 2022

Create Serverless API

Create Serverless APIs with no infra configuration.

It is an aws serverless-based backend api template created for beginners.

You can service api without knowing the cloud infrastructure.

And Create Serverless API works on macOS, Windows, and Linux.

Create Serverless API was inspired by the create-react-app.

πŸš€ Quick Overview

πŸ“Œ Before we proceed with the work below, you must set aws credential

```
npx create-serverless-api my-api
cd my-api
npm bootstrap
npm deploy
```

And Check the api endpoint output to the terminal.

You will have a fully operational api service.

For detail, please refer to the explanation below.

✨ Feature

  • Automatic aws infrastructure completion through documents in the OpenAPI specification.
  • Install only essential packages for each API.

Detail Feature

πŸ‘ The detail feature roughly say that this package is very cool.

  • Infrastructure distribution through IaC makes it easy to modify.
  • Using FaaS, monitoring is easy and stability can be obtained by horizontal expansion.
  • Supports monitoring and logging with aws X-ray and aws CloudWatch.
  • Babel settings are set for using typescript.
  • Can execute local test similar to the aws lambda.

Environment in Lambda Container

βœ… You can customize this.

  • Node 14.x

Detail Usage

  • ⚠ Caution Following this usage, your api will be serviced as a cloud service. You spend money according to the amount of api calls. so make sure to check out AWS Pricing Policy.
  1. Login to aws console

  2. Make iam user through aws IAM users.

    • Need Access key credential type.
    • Recommend AdministratorAccess policy through the attachment policies directy button for easy work.
    • Save the access key ID and secret access key that came out like that.
  3. Configurate your aws credentials file

    βœ… Windows default path: C/Users/{userName}/.aws/credentials βœ… Linux or macOS default path: ~/.aws/credentials

    [development]
    aws_access_key_id={your_aws_access_key_id}
    aws_secret_access_key={your_aws_secret_access_key}
    
    [production]
    aws_access_key_id={your_aws_access_key_id}
    aws_secret_access_key={your_aws_secret_access_key}
    

    πŸ“Œ If you want to change the name, please change it with the script of package.json

  4. Creating an API

    npx create-serverless-api my-api
    

npx create-serverless-api my-api

  1. Go the project directory.

    cd my-api
    

npx create-serverless-api my-api

  1. Bootstrap for aws deployment.

    // Development
    npm run bootstrap
    
    // Production
    npm run bootstrap-prod
    
  2. Deploy to aws

    βœ… The api is served on the address output to the terminal, so make sure to save it.

    // Development
    npm run deploy
    
    // Production
    npm run deploy-prod
    
  • Local execute

    npm run offline
    
  • Destroy the api

    // Development
    npm run destroy
    
    // Production
    npm run destroy-prod
    

πŸ‘ Contributing

Pull requests and 🌟 stars are always welcome.

For major changes, please open an issue first to discuss what you would like to change.

πŸ“© Contact

[email protected]

Others

πŸ‘ We recommend third-party services that suit the characteristics of serverless services.

  • We recommand Dash Bird service for watch lambda infomations.
  • We recommand Planet Scale service for database server.

GitHub

https://github.com/zao95/create-serverless-api
You might also like...

React Covid: a practical project to user APIs in a base level

React Covid: a practical project to user APIs in a base level

React Covid This a practical project to user APIs in a base level. Just fetch data and render it in components. API This project use the same API that

Jul 25, 2022

Bitloops is Low-Code Workflow Orchestration platform that helps you build backend systems and APIs 10x faster.

Bitloops is Low-Code Workflow Orchestration platform that helps you build backend systems and APIs 10x faster.

Bitloops Bitloops is a scalable open source Firebase substitute that can support any database and workflow orchestration. We’re building Bitloops usin

Jul 4, 2022

Bakers' Forum - A forum app built using React, Redux, Typescript, Material UI and Mockbee APIs

Bakers' Forum - A forum app built using React, Redux, Typescript, Material UI and Mockbee APIs

Bakers' Forum - A Forum App Table of contents About Bakers' Forum Features and demo Technology and libraries used Pre-requisites and project setup(in

Jun 6, 2022

☁️ React Weather App. Uses Openweathermap.org APIs

☁️ React Weather App. Uses Openweathermap.org APIs

☁️ React Weather App. Uses Openweathermap.org APIs

Jul 28, 2022

A Spotify Clone which built with ReactJS. 3rd party API integration, user authentication, spotify API, responsive design, material-ui, react context api are used to built it.

Spotify Clone with ReactJS In this Spotify Clone application you can log in to the application with your spotify account and see your own playlist. Sp

Jul 11, 2022

Refactoring a MERN stack react based front end starter code with a fully functioning Google Books API search engine built with RESTful API to be built with GRAPHQL API with Apollo Server.

Refactoring a MERN stack react based front end starter code with a fully functioning Google Books API search engine built with RESTful API to be built with GRAPHQL API with Apollo Server.

21_MERN_GoogleBookSearchEngine Task Refactoring a MERN stack react based front end starter code with a fully functioning Google Books API search engin

Apr 9, 2022

Single Page Application built using React, Context API and OMDb API.

Single Page Application built using React, Context API and OMDb API.

Movie Search App This project is a React application with functions to search for movies and add movies to favorites using OMDb API. Home Page Favorit

Jul 21, 2022

Currency converter made with React, XE API and REST Countries API.

Currency Converter HOW TO RUN THE APP To run the app from the terminal, navigate to the root folder and first run 'npm i' to install the node modules.

Nov 25, 2021

Weather Application built using ReactJs , OpenCage API and OpenWeatherMap API

Weather-bot Netlify Site Status : Weather application built using ReactJs, OpenCage Api and OpenWeatherMap Api Tech Stack and Dependencies Name Descri

May 13, 2022
An example configuration of a fullstack Node app with PostgreSQL using Docker Compose
An example configuration of a fullstack Node app with PostgreSQL using Docker Compose

Usage To use this project make sure you have Docker installed then run the follo

Aug 3, 2022
React SPA App with Serverless Backend and Congito Auth Demo
React SPA App with Serverless Backend and Congito Auth Demo

React SPA App with Serverless Backend and Congito Auth Demo Overview This samples shows how to make a SPA application with serverless backend by AWS C

Aug 5, 2022
Rent-A-Car - Serverless ReactJS SPA

Rent-A-Car gives you opportunity easily renting and renting out cars, managing users, earning money.

Jul 1, 2022
A serverless, real-time, wordle-inspired, multiplayer game
A serverless, real-time, wordle-inspired, multiplayer game

fivebysix.com A multiplayer, worlde-inspired web app. Demo Technologies 100% TypeScript (including IAC via CDK) Vite React / Redux AWS AppSync Dynamo

Jun 16, 2022
CodeClan - Week 9 - Group Project - App created using React, MongoDB and multiple APIs

Education Station Synopsis This app was completed by Cohort E49 for CodeClan's Professional Software Development course. The brief was to create an ed

Jul 14, 2021
A full Realtime Chat Application with Social Auth and dedicated chat APIs/sockets.
A full Realtime Chat Application with Social Auth and dedicated chat APIs/sockets.

Iced-Chat A full Realtime Chat Application with Social Auth and dedicated chat APIs/sockets. It uses Firebase(from google) for auth. It also uses Chat

Jul 1, 2022
it is a React application which uses SpaceX open source graphql APIs

spaceX-mini-project it is a React application which uses SpaceX open source graphql APIs

Nov 5, 2021
Website using React and Rick and Morty APIs

RICK and MORTY WORKSHOP ?? ?? ?? ?? Website using Rick and Morty APIs. It lists

Jan 14, 2022
A React Realtime Chat Application with Social Auth and dedicated chat APIs/sockets.
A React Realtime Chat Application with Social Auth and dedicated chat APIs/sockets.

Chat-Room This is a fully responsive React chat application with social authentication including Google and Facebook using Firebase online statuses, g

May 23, 2022
A weather app that was built using weather APIs and is a PWA web app
A weather app that was built using weather APIs and is a PWA web app

This is a weather app that was built using weather APIs and is a PWA web app.

May 13, 2022