https://github.com/lucianopaci/serverless-stack-api
Serverless Stack API for the NoteApp
https://github.com/lucianopaci/serverless-stack-api
Last synced: 3 months ago
JSON representation
Serverless Stack API for the NoteApp
- Host: GitHub
- URL: https://github.com/lucianopaci/serverless-stack-api
- Owner: LucianoPaci
- License: mit
- Created: 2019-04-28T15:14:50.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-04-29T00:14:44.000Z (about 6 years ago)
- Last Synced: 2025-01-17T03:33:00.545Z (4 months ago)
- Language: JavaScript
- Size: 225 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Serverless Node.js Starter
A Serverless starter that adds ES7 syntax, serverless-offline, environment variables, and unit test support. Part of the [Serverless Stack](http://serverless-stack.com) guide.
[Serverless Node.js Starter](https://github.com/AnomalyInnovations/serverless-nodejs-starter) uses the [serverless-webpack](https://github.com/serverless-heaven/serverless-webpack) plugin, [Babel](https://babeljs.io), [serverless-offline](https://github.com/dherault/serverless-offline), and [Jest](https://facebook.github.io/jest/). It supports:
- **ES7 syntax in your handler functions**
- Use `import` and `export`
- **Package your functions using Webpack**
- **Run API Gateway locally**
- Use `serverless offline start`
- **Support for unit tests**
- Run `npm test` to run your tests
- **Sourcemaps for proper error messages**
- Error message show the correct line numbers
- Works in production with CloudWatch
- **Automatic support for multiple handler files**
- No need to add a new entry to your `webpack.config.js`
- **Add environment variables for your stages**
---
### Demo
A demo version of this service is hosted on AWS - [`https://z6pv80ao4l.execute-api.us-east-1.amazonaws.com/dev/hello`](https://z6pv80ao4l.execute-api.us-east-1.amazonaws.com/dev/hello)
And here is the ES7 source behind it
``` javascript
export const hello = async (event, context, callback) => {
const response = {
statusCode: 200,
body: JSON.stringify({
message: `Go Serverless v1.0! ${(await message({ time: 1, copy: 'Your function executed successfully!'}))}`,
input: event,
}),
};
callback(null, response);
};
const message = ({ time, ...rest }) => new Promise((resolve, reject) =>
setTimeout(() => {
resolve(`${rest.copy} (with a delay)`);
}, time * 1000)
);
```
### Requirements
- [Install the Serverless Framework](https://serverless.com/framework/docs/providers/aws/guide/installation/)
- [Configure your AWS CLI](https://serverless.com/framework/docs/providers/aws/guide/credentials/)
### Installation
To create a new Serverless project.
``` bash
$ serverless install --url https://github.com/AnomalyInnovations/serverless-nodejs-starter --name my-project
```
Enter the new directory
``` bash
$ cd my-project
```
Install the Node.js packages
``` bash
$ npm install
```
### Usage
To run unit tests on your local
``` bash
$ npm test
```
To run a function on your local
``` bash
$ serverless invoke local --function hello
```
To simulate API Gateway locally using [serverless-offline](https://github.com/dherault/serverless-offline)
``` bash
$ serverless offline start
```
Run your tests
``` bash
$ npm test
```
We use Jest to run our tests. You can read more about setting up your tests [here](https://facebook.github.io/jest/docs/en/getting-started.html#content).
Deploy your project
``` bash
$ serverless deploy
```
Deploy a single function
``` bash
$ serverless deploy function --function hello
```
To add another function as a new file to your project, simply add the new file and add the reference to `serverless.yml`. The `webpack.config.js` automatically handles functions in different files.
To add environment variables to your project
1. Rename `env.example` to `env.yml`.
2. Add environment variables for the various stages to `env.yml`.
3. Uncomment `environment: ${file(env.yml):${self:provider.stage}}` in the `serverless.yml`.
4. Make sure to not commit your `env.yml`.
### Support
- Send us an [email](mailto:[email protected]) if you have any questions
- Open a [new issue](https://github.com/AnomalyInnovations/serverless-nodejs-starter/issues/new) if you've found a bug or have some suggestions.
- Or submit a pull request!
### Maintainers
Serverless Node.js Starter is maintained by Frank Wang ([@fanjiewang](https://twitter.com/fanjiewang)) & Jay V ([@jayair](https://twitter.com/jayair)). [**Subscribe to our newsletter**](http://eepurl.com/cEaBlf) for updates. Send us an [email](mailto:[email protected]) if you have any questions.