Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jch254/serverless-node-dynamodb-api
API powered by Serverless, TypeScript, Webpack and DynamoDB, intended as a starting point for Serverless APIs
https://github.com/jch254/serverless-node-dynamodb-api
api apiary auth0 authentication aws aws-lambda docker dynamodb nodejs serverless serverless-offline starter-kit tyepscript typescript webpack
Last synced: 5 days ago
JSON representation
API powered by Serverless, TypeScript, Webpack and DynamoDB, intended as a starting point for Serverless APIs
- Host: GitHub
- URL: https://github.com/jch254/serverless-node-dynamodb-api
- Owner: jch254
- License: mit
- Created: 2016-10-04T03:48:34.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-04-05T03:09:42.000Z (7 months ago)
- Last Synced: 2024-04-14T07:22:44.532Z (7 months ago)
- Topics: api, apiary, auth0, authentication, aws, aws-lambda, docker, dynamodb, nodejs, serverless, serverless-offline, starter-kit, tyepscript, typescript, webpack
- Language: TypeScript
- Homepage: https://serverless-api.603.nz
- Size: 449 KB
- Stars: 83
- Watchers: 4
- Forks: 12
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# [Serverless-node-dynamodb-api](https://serverless-api.603.nz)
API powered by Serverless, TypeScript, Webpack, Node.js and DynamoDB, intended as a starting point for Serverless APIs. I've also created a [React/Redux-powered UI](https://github.com/jch254/serverless-node-dynamodb-ui) to front this API. Auth0 handles authentication. You must signup/login to generate an auth token and gain access to the secured area. All endpoints in the API check validity of the auth token and return unauthorised if invalid, the UI then prompts you to log in again. The API also determines the identity of the user via the auth token.
See [Apiary](http://docs.serverlessapi.apiary.io) for API structure - defined in [apiary.apib](./apiary.apib).
## Technologies Used
- [Serverless](https://github.com/serverless/serverless)
- [TypeScript](https://github.com/microsoft/typescript)
- [Node.js](https://github.com/nodejs/node)
- [Webpack](https://github.com/webpack/webpack)
- [DynamoDB](https://aws.amazon.com/dynamodb)
- [Serverless-offline](https://github.com/dherault/serverless-offline)
- [Serverless-webpack](https://github.com/elastic-coders/serverless-webpack)
- [Serverless-dynamodb](https://github.com/raisenational/serverless-dynamodb)
- [Serverless-domain-manager](https://github.com/amplify-education/serverless-domain-manager)
- [Jsonwebtoken](https://github.com/auth0/node-jsonwebtoken)
- [Docker](https://www.docker.com)
---
## Running locally (with live-reloading and local DynamoDB server)
To run locally you must run two servers - DB and API.
Serverless-webpack, serverless-dynamodb-local and serverless-offline offer great tooling for local Serverless development. To start local servers that mimic AWS API Gateway and DyanamoDB, run the commands below. Both servers will fire up and code will be reloaded upon change so that every request to your API will serve the latest code.
Serverless-dynamodb-local requires Java Runtime Engine (JRE) version 6.x or newer.
**AUTH0_CLIENT_SECRET environment variable must be set before `yarn run dev` command below. Optional DYNAMODB_PORT and DYNAMODB_HOST environment variables may be set to override the defaults (localhost:8000).**
E.g. `AUTH0_CLIENT_SECRET=YOUR_SECRET yarn run dev`
```
yarn install (serverless dynamodb install included as postinstall script)
yarn run dev
```
Submit requests to http://localhost:3000. The DynamoDB shell console is available at http://localhost:8000/shell.
## Running locally with Docker
Maintaining a Java installation for the sake of running DynamoDB locally is a pain, running in a Docker container is far easier. As above, to run locally you must run two servers - DB and API.
To start the local servers that mimic AWS API Gateway and DyanamoDB using docker, run the commands below.
**AUTH0_CLIENT_SECRET environment variable must be set before `docker-compose up --build` command below.**
E.g. `AUTH0_CLIENT_SECRET=YOUR_SECRET docker-compose up --build`
```
docker-compose up --build
```
Submit requests to http://localhost:3000. The DynamoDB shell console is available at http://localhost:8000/shell.
## Testing
TBC
### Deployment/Infrastructure
Refer to the [/infrastructure](./infrastructure) directory.