Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
Lukas Wittich committed Jul 17, 2018
1 parent bc48370 commit 68fe284
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 2 deletions.
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
node_modules/
.serverless/
README.md
.serverless/
45 changes: 45 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Serverless GraphQL AppSync & RDS implementation

## Introduction

I am a co-founder of [getsby](https://gets.by/) and I'm currently developing a GraphQL service for us. In our development process I encountered several difficulties concerning the serverless framework in combination with AWS AppSync & RDS. We finally got our service up running and therefore I want to share my achievements with the community.

## Getting Started

This repository provides an example implementation of a GraphQL endpoint with AWS AppSync & RDS using the [serverless framework](https://serverless.com/).

### Prerequisites

You'll need the following things to get started:
- A database with some sampledata (Use our *db.sql* for this example)
- Fill in the blanks in the *serverless.yml* file
- Grab yourself a cup of coffee

### Installing

Install all the dependencies:

```
yarn install
```

## Deployment

To deploy the service simply run the following command:

```
serverless deploy
```

## Testing

Test your new deployed service in the AppSync console or connect a client to it.

## Authors

* **Lukas Wittich** - [getsbydev](https://github.com/getsbydev)

## Acknowledgments

* To accomplish our goal I carefully read the majority of the examples provided in the [serverless/serverless-graphql](https://github.com/serverless/serverless-graphql) repository and combined the gained knowledge in our implementation. I really appreciate the work you guys did there, thank you!
* If you have any questions or feedback feel free to contact me

0 comments on commit 68fe284

Please sign in to comment.