https://github.com/hyperjumptech/esignature
Hyperjump's electronic document signing application
https://github.com/hyperjumptech/esignature
Last synced: 4 months ago
JSON representation
Hyperjump's electronic document signing application
- Host: GitHub
- URL: https://github.com/hyperjumptech/esignature
- Owner: hyperjumptech
- License: mit
- Created: 2023-01-18T02:37:25.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-01T02:13:52.000Z (over 3 years ago)
- Last Synced: 2025-01-20T06:33:09.118Z (over 1 year ago)
- Language: Java
- Size: 9.79 MB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# esignature
This is a hyperjump's electronic signature open source application
## Project Structure
This project is generated based on jhipster framework. Node is required for generation and recommended for development. `package.json` is always generated for a better development experience with prettier, commit hooks, scripts and so on.
`/src/*` structure follows default Java structure.
- `/src/main/java` - java files.
- `/src/main/webapp/app` - is where the react files placed. To create or modify the ui you need to add changes to the files in this folder.
- `.jhipster/*.json` - JHipster entity configuration files
- `npmw` - wrapper to use locally installed npm.
JHipster installs Node and npm locally using the build tool by default. This wrapper makes sure npm is installed locally and uses it avoiding some differences different versions can cause. By using `./npmw` instead of the traditional `npm` you can configure a Node-less environment to develop or test your application.
- `/src/main/docker` - Docker configurations for the application and services that the application depends on
## Development
Before you can build this project, you must install and configure the following dependencies on your machine:
1. [Node.js][]: We use Node to run a development web server and build the project.
Depending on your system, you can install Node either from source or as a pre-packaged bundle.
After installing Node, you should be able to run the following command to install development tools.
You will only need to run this command when dependencies change in [package.json](package.json).
```
npm install
```
2. [Postgresql][]: We are using potsgres database to save the application data.
Before running the application you need to create a database instance with the name `esignature`.
You can set also the user and password for this database instance. To connect the database with
the application you need to setup the configuration in `/src/main/resources/config/application-dev.yml` file.
set the database configuration in the datasource section :
```
datasource:
type: com.zaxxer.hikari.HikariDataSource
url: jdbc:postgresql://localhost:5432/esignature
username:
password:
hikari:
poolName: Hikari
auto-commit: false
```
We use npm scripts and [Webpack][] as our build system.
Run the following commands in two separate terminals to create a blissful development experience where your browser
auto-refreshes when files change on your hard drive.
```
./mvnw
npm start
```
`./mvnw` command will run auto populate for all the tables and default data needed by the application. It will also run the java version of the application. You can access the application in this address `http://localhost:8080`
`npm start` will be needed if you want to have that auto-refresher whenever there are any changes applied to the files. You can access the application with auto refresh in this address `http://localhost:9001`
### Managing dependencies
For example, to add [Leaflet][] library as a runtime dependency of your application, you would run following command:
```
npm install --save --save-exact leaflet
```
To benefit from TypeScript type definitions from [DefinitelyTyped][] repository in development, you would run following command:
```
npm install --save-dev --save-exact @types/leaflet
```
Then you would import the JS and CSS files specified in library's installation instructions so that [Webpack][] knows about them:
Note: There are still a few other things remaining to do for Leaflet that we won't detail here.
## Building for production
### Packaging as jar
To build the final jar and optimize the esignature application for production, run:
```
./mvnw -Pprod clean verify
```
This will concatenate and minify the client CSS and JavaScript files. It will also modify `index.html` so it references these new files.
To ensure everything worked, run:
```
java -jar target/*.jar
```
Then navigate to [http://localhost:8080](http://localhost:8080) in your browser.
### Packaging as war
To package your application as a war in order to deploy it to an application server, run:
```
./mvnw -Pprod,war clean verify
```
### Code quality
Sonar is used to analyse code quality. You can start a local Sonar server (accessible on http://localhost:9001) with:
```
docker-compose -f src/main/docker/sonar.yml up -d
```
Note: we have turned off authentication in [src/main/docker/sonar.yml](src/main/docker/sonar.yml) for out of the box experience while trying out SonarQube, for real use cases turn it back on.
You can run a Sonar analysis with using the [sonar-scanner](https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner) or by using the maven plugin.
Then, run a Sonar analysis:
```
./mvnw -Pprod clean verify sonar:sonar
```
If you need to re-run the Sonar phase, please be sure to specify at least the `initialize` phase since Sonar properties are loaded from the sonar-project.properties file.
```
./mvnw initialize sonar:sonar
```
## Using Docker to simplify development (optional)
You can use Docker to improve your esignature development experience. A number of docker-compose configuration are available in the [src/main/docker](src/main/docker) folder to launch required third party services.
For example, to start a postgresql database in a docker container, run:
```
docker-compose -f src/main/docker/postgresql.yml up -d
```
To stop it and remove the container, run:
```
docker-compose -f src/main/docker/postgresql.yml down
```
You can also fully dockerize your application and all the services that it depends on.
To achieve this, first build a docker image of your app by running:
```
npm run java:docker
```
Or build a arm64 docker image when using an arm64 processor os like MacOS with M1 processor family running:
```
npm run java:docker:arm64
```
Then run:
```
docker-compose -f src/main/docker/app.yml up -d
```