Skip to content

Commit deb7b25

Browse files
committed
Renaming project/build artifact, and touching upb the README.md for first release.
1 parent d981fd7 commit deb7b25

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# APIGatewayServerlessExample
1+
# APIGatewayServerlessJavaExample
22

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.
44

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.
66

77
## Getting Started
88

@@ -23,20 +23,20 @@ I suggest you do the following before cloning this project:
2323

2424
* Clone this repository to your local machine (directions [here](https://help.github.com/articles/cloning-a-repository/)).
2525
* 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).
2828

2929
## Running Tests
3030

3131
There is a reasonably full suite of tests for this repository; run them via IntelliJ or Maven.
3232

3333
## Contributing
3434

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.
3636

3737
## Versioning
3838

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).
4040

4141
## Authors
4242

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<modelVersion>4.0.0</modelVersion>
66

77
<groupId>com.stevezero.aws.api.apps.goaltender</groupId>
8-
<artifactId>GoalTenderAWS</artifactId>
8+
<artifactId>GoalTenderAPI</artifactId>
99
<version>1.0-SNAPSHOT</version>
1010
<properties>
1111
<maven.compiler.source>1.8</maven.compiler.source>

0 commit comments

Comments
 (0)