This is a simple framework for implementing a serverless RESTful API fronted by API Gateway and powered by AWS Lambda functions written in Java 8.
The sample implementation is an API backing GoalTender (a React Native app), using DynamoDb as a storage provider.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Unfortunately, you're on your own with regards to building your own production environment. Luckily, there are lots of guides out there; here is one I found particularly helpful.
I suggest you do the following before cloning this project:
- Download the IntelliJ IDEA.
- Ensure you have Java JDK 1.8 installed.
- Create a GitHub account.
- Set up GitHub over SSH.
- Clone this repository to your local machine (directions here).
- I strongly suggest creating a local branch before making any changes.
- Open IntelliJ and import the Maven project.
- To build a jar with dependencies (suitable for deploying to a AWS lambda), use the Maven Assembly Plugin.
There is a reasonably full suite of tests for this repository; run them via IntelliJ or Maven.
I rather like this CONTRIBUTING.md; let's follow that for any pull requests. Improvements always welcome--this codebase has a lot of room to get better.
I use SemVer for versioning. For the versions available, see the tags on this repository.
- Steve Martin - Initial work - Fitzcairn
This project is licensed under the MIT License - see the LICENSE.md file for details