Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mrin9 committed Oct 20, 2018
1 parent 344e65f commit 7e605ec
Showing 1 changed file with 56 additions and 6 deletions.
62 changes: 56 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Component | Technology
Backend Lang | Java 11 (with modules)
Restfull Framwork | Jersey
Container | Tomcat 9 (Embeded Mode)
Backend Build Tool | Maven 3.5.4 (Creates a Executable Jar with tomcat embeded )
Server Build Tools | maven 3.5.4 (Creates a Executable Jar with tomcat embeded )
Security | Token Based (Spring Security and [JWT](https://github.com/auth0/java-jwt) )
REST Spec | [Open API Standard](https://www.openapis.org/)
In Memory DB | H2
Expand All @@ -21,13 +21,64 @@ Client Build Tools | vue-cli, Webpack, yarn

## Prerequisites
Ensure you have this installed before proceeding further
- Java 11+
- Java 11+
- Maven 3.5.4+
- yarn 1.10.1
- node 10.12.0
- vue-cli 3.0.5

## Folder Structure
```bash
PROJECT_FOLDER
│ README.md
│ pom.xml # Parent maven project (contains other sub projects)
└──[database] # Java-Module ( Java project that contains Database related services )
│ │ pom.xml
│ └──[src]
│ └──[main]
│ └──[java] # java source files
│ └──[resources]
│ schema.sql # Contains sql script to generate database tables and views in H2
│ data.sql # Contains sql script to fill the tables with sample data
└──[web-api] # Java-Module ( Java project for RESTfull APIs )
│ │ pom.xml
│ └──[src]
│ └──[main]
│ └──[java] # java source files
│ └──[resources]
│ └──[webapp] # files/folders under webapp is accessible from web-browser
│ └──[ui] # the pom.xml copies web-ui/dist into this folder, to make UI available from the browser
│ └──[api-docs] # contains swagger-ui source for API documentation and try-out
└──[web-ui] # A regular folder that contains UI source code
│ │ package.json
│ │ vue.config.js
│ │ package.json
│ └──[node_modules] # files under this is dounloaded by 'yarn install' command
│ └──[dist] # VueJs source is compiled, bundled and minified into this folder
│ └──[src] # contains ui source code
```

### Build Process
- Build Frontend (optional step, requiered only if you make changes to fronend code )
- Build Backend

### Build Frontend (optional step)
```bash
# run these commands from web-ui folder

### Easy Build and Run
yarn install
yarn build

```

### Build Backend
```bash
# Maven Build : Navigate to the root folder where pom.xml is present
# run these commands from root folder where top-level pom.xml is present

# build the web app
mvn clean install

# Run The App
Expand All @@ -42,8 +93,7 @@ URL to Access H2 DB | http:https://localhost:8082
URL for REST APIs | http:https://localhost:8080/api

## Backers

Help me to host this app on AWS or Google-Cloud, for everyone to checkout the app. $5 will allow me to host for a month !!!
Help me to host this app on AWS or Google-Cloud, for everyone to checkout the app.
[[Become a backer](https://opencollective.com/angular-springboot-rest-jwt#backer)]

<a href="https://opencollective.com/angular-springboot-rest-jwt#backers" target="_blank"><img src="https://opencollective.com/angular-springboot-rest-jwt/backers.svg?width=890"></a>
Expand Down

0 comments on commit 7e605ec

Please sign in to comment.