https://github.com/amodinho/serverless-graphql-typescript-starter
A Serverless GraphQL TypeScript backend boilerplate 🛎️
https://github.com/amodinho/serverless-graphql-typescript-starter
apollo-server apollo-server-lambda aws-lambda graphql
Last synced: 11 months ago
JSON representation
A Serverless GraphQL TypeScript backend boilerplate 🛎️
- Host: GitHub
- URL: https://github.com/amodinho/serverless-graphql-typescript-starter
- Owner: AmoDinho
- License: mit
- Created: 2019-12-18T10:31:38.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-02-01T21:24:46.000Z (about 5 years ago)
- Last Synced: 2025-03-31T09:37:20.105Z (12 months ago)
- Topics: apollo-server, apollo-server-lambda, aws-lambda, graphql
- Language: TypeScript
- Homepage:
- Size: 844 KB
- Stars: 11
- Watchers: 1
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Serverless GraphQL TypeScript Starter 
This is a basic TypeScript boilerplate to kitstart your Serverless GraphQL projects with AWS Lambda. Here is a [plain JavaScript starter](https://github.com/pimp-my-book/serverless-graphql-nodejs-starter) if you prefer!
It is powered by [`Apollo-Server-Lambda`](https://github.com/apollographql/apollo-server/tree/master/packages/apollo-server-lambda) and uses the [Serverless Framework](https://serverless.com/) to deploy it to AWS.
This is hugely inspired by the starter that [Anomaly Innovations](https://github.com/AnomalyInnovations/serverless-nodejs-starter ) created. The project was cloned from it.
## Prerequistes 🚁
* [An AWS Account](https://aws.amazon.com/)
* [A configured AWS CLI](https://serverless.com/framework/docs/providers/aws/guide/credentials/)
* [Serverless Framework installed on your machine](https://serverless.com/framework/docs/providers/aws/guide/installation/)
* [NodeJS](nodejs.org)
Note this project uses [Yarn](https://yarnpkg.com).
## How to get started 🎮
First clone the repo:
```
$ serverless install --url https://github.com/AmoDinho/serverless-graphql-typescript-starter --name project-name
```
Move into the project folder:
```
$ cd project-name
```
Then Install all its dependancies:
```
$ yarn install
```
Then you should be able to invoke the Lambda locally:
```
$ yarn offline
```
To deploy to AWS run the following command:
```
$ yarn deploy
```
This should be a good start to be able to move on and do whatever you gotta do meet business requirements.
### How To Link Other AWS Services 🗽
#### DynamoDB
#### Cognito
## Contributing😀
Contributions are most welcome!!