You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
-
# APIGatewayServerlessExample
1
+
# APIGatewayServerlessJavaExample
2
2
3
-
This is a simple framework for implementing a serverless RESTful API via [AWS Lambda](https://aws.amazon.com/lambda/)functions, and fronted by [API Gateway](https://aws.amazon.com/api-gateway/).
3
+
This is a simple framework for implementing a serverless RESTful API fronted by [API Gateway](https://aws.amazon.com/api-gateway/) and powered by [AWS Lambda](https://aws.amazon.com/lambda/) functions written in Java 8.
4
4
5
-
The sample implementation is an API intended to back[GoalTender](https://github.com/fitzcairn/GoalTender) (a React Native app), using [DynamoDb](https://aws.amazon.com/dynamodb/) as a storage provider.
5
+
The sample implementation is an API backing[GoalTender](https://github.com/fitzcairn/GoalTender) (a React Native app), using [DynamoDb](https://aws.amazon.com/dynamodb/) as a storage provider.
6
6
7
7
## Getting Started
8
8
@@ -23,20 +23,20 @@ I suggest you do the following before cloning this project:
23
23
24
24
* Clone this repository to your local machine (directions [here](https://help.github.com/articles/cloning-a-repository/)).
25
25
* I strongly suggest [creating a local branch](https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging) before making any changes.
26
-
* Open IntelliJ, and create your project by [importing the Maven project](https://www.lagomframework.com/documentation/1.4.x/java/IntellijMaven.html).
27
-
*[Open the Gradle tool window in IntelliJ](https://www.jetbrains.com/help/idea/jetgradle-tool-window.html), expand "Tasks", expand "application", and double-click "run".
26
+
* Open IntelliJ and[import the Maven project](https://www.lagomframework.com/documentation/1.4.x/java/IntellijMaven.html).
27
+
*To build a jar with dependencies (suitable for deploying to a AWS lambda), use the [Maven Assembly Plugin](https://maven.apache.org/plugins/maven-assembly-plugin/usage.html).
28
28
29
29
## Running Tests
30
30
31
31
There is a reasonably full suite of tests for this repository; run them via IntelliJ or Maven.
32
32
33
33
## Contributing
34
34
35
-
I rather like this [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426); let's follow that for any pull requests.
35
+
I rather like this [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426); let's follow that for any pull requests. Improvements always welcome--this codebase has a lot of room to get better.
36
36
37
37
## Versioning
38
38
39
-
I use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/fitzcairn/APIGatewayServerlessExample/tags).
39
+
I use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/fitzcairn/APIGatewayServerlessJavaExample/tags).
0 commit comments