https://github.com/systangotechnologies/serverless-node-simple-crud
Simple AWS lambda function for CRUD operations
https://github.com/systangotechnologies/serverless-node-simple-crud
Last synced: 9 months ago
JSON representation
Simple AWS lambda function for CRUD operations
- Host: GitHub
- URL: https://github.com/systangotechnologies/serverless-node-simple-crud
- Owner: SystangoTechnologies
- Created: 2019-05-14T10:56:06.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-05-14T11:11:59.000Z (over 6 years ago)
- Last Synced: 2025-03-29T21:51:10.267Z (10 months ago)
- Language: JavaScript
- Size: 21.5 KB
- Stars: 79
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# serverless-node-simple-crud
Simple AWS lambda serverless function for crud operations using Expressjs.
## Setup
- Install `node`, `npm`
- Run the following commands
```sh
# Install serverless globally
$ npm install -g serverless
# Provide credentials of AWS to serverless
$ sls config credentials --provider aws --key PUBLIC_KEY --secret SECRET_KEY
# Install dependencies
$ npm install
# Export Env variable
$ export MY_API_KEY= Some text for api key generation
```
## Deployment
Setup the following variables into your AWS lambda function.
```
NODE_ENV=production/development
DATABASE= Name of the database.
DB_USERNAME= Database user name
DB_PASSWORD= Database password
DB_HOST= Database host
DB_PORT= Database port
```
Deploying serverless function to AWS.
```sh
$ sls deploy # Deploying serverless function to AWS
```
## Running
- Make a POST APIs call with the API URL returned.
- Set API key value in the x-api-key header of every request.
- The API key is auto-generated by AWS and printed on the screen while running 'sls deploy'.
- Refer to postman collection in the codebase with the file named 'serverless-node-simple-crud.postman_collection.json'
## Contributors
[Vikas Patidar](https://www.linkedin.com/in/vikas-patidar-0106/)
## License
Built under [MIT](http://www.opensource.org/licenses/mit-license.php) license.