Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
emiteze committed Aug 3, 2017
1 parent 1fe26f8 commit dad3f23
Show file tree
Hide file tree
Showing 15 changed files with 20 additions and 31 deletions.
2 changes: 1 addition & 1 deletion .gitignore
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ target/
.mvn/
mvnw
mvnw.cmd
data/
data/db/*

### IntelliJ IDEA ###
.idea
Expand Down
25 changes: 19 additions & 6 deletions README.md
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,21 @@
## Quick Start

> 1. Install [Compose](http://gradle.org/gradle-download/)
> 2. Clone this repository using ` git clone https://github.com/emiteze/xy-inc.git `
> 3. Execute the command ` docker-compose up ` in the root of the project
> 4. Open in your browser the URL ` http://localhost:8080/swagger-ui.html `
> 1.Install [MongoDB](https://www.mongodb.com/download-center), [Java](https://www.java.com/pt_BR/download/) and [Maven](https://maven.apache.org/download.cgi)
>
> 2.Clone this repository using ` git clone https://github.com/emiteze/xy-inc.git `
>
> 3.On the root of the project, run:
>
> ``` mongod --dbpath=data/db (this will initiate a mongodb server at localhost:27017) ```
>
> ``` mvn dependency:resolve (this will handle the dependencies of the project) ```
>
> ``` mvn clean install (this will build the project) ```
>
> ``` mvn spring-boot:run (this will start the webservice at localhost:8080) ```
>
> 4.Open in your browser the URL ` http://localhost:8080/swagger-ui.html ` to test the webservice or use any HttpClient that you want.
## Endpoints

Expand Down Expand Up @@ -94,7 +105,9 @@ Point Of Interest object
>
> Git Repository
> * [GitHub](https://github.com/)
>
> Deploy
## Future Improvements

> Dockerize our project to simplify the build and run process to just one line command.
> * [Docker](http://www.docker.com/)
> * [Docker Compose](http://www.docker.com/products/docker-compose)
24 changes: 0 additions & 24 deletions docker-compose.yml

This file was deleted.

Empty file modified pom.xml
100644 → 100755
Empty file.
Empty file modified src/main/java/zup/mateus/cruz/xyinc/XyIncApplication.java
100644 → 100755
Empty file.
Empty file.
Empty file.
Empty file.
Empty file modified src/main/java/zup/mateus/cruz/xyinc/model/PointOfInterest.java
100644 → 100755
Empty file.
Empty file.
Empty file.
Empty file modified src/main/resources/application.properties
100644 → 100755
Empty file.
Empty file.
Empty file.
Empty file.

0 comments on commit dad3f23

Please sign in to comment.