rasoftwaredivision / RisingArjun

Rising Arjun Repository
0 stars 2 forks source link

RisingArjun

This application was generated using JHipster 6.1.2, you can find documentation and help at https://www.jhipster.tech/documentation-archive/v6.1.2.

Development

Before you can build this project, you must install and configure the following dependencies on your machine: A) Preconditions (Software to be installed):

  1. JDK 12
  2. Eclipse IDE
  3. Install JHipster plugin in eclispe for JDL design
  4. Install gpaphviz 2.38 version for display of ER diagrams of JDL. Higher versions of graphviz has compatability issues. graphviz-2.38.msi for can be installed from

https://www.softpedia.com/get/Others/Miscellaneous/Graphviz.shtml#download Go over https://www.youtube.com/watch?v=LERTahPqVjo for eclipse JHispter plugin installation and usage. Set environment variable GRAPHVIZ_HOT to point to dot.exe eg C:\Program Files (x86)\Graphviz2.38\bin\dot.exe Also update PATH variable to point to Graphviz bin folder eg C:\Program Files (x86)\Graphviz2.38\bin\

  1. maven for build

  2. Git client for code checkin/pull from Github

  3. install postgresql-12.4-1-windows-x64 with superuser (postgres, root) & listening port 5432

  4. Install dbvis_windows-x64_11_0_5_jre (Optional. You can use PSQL command line utility as well).

  5. Open PSQL command line. Press enter till it asks for password and enter root as password. Create DB & DB user CREATE DATABASE risingarjun; CREATE USER risingarjun WITH PASSWORD 'risingarjun'; GRANT ALL ON DATABASE risingarjun TO risingarjun;

  6. 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. npm install 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

    1. Debugging: If you get any build failures do this: mvnw clean npm run cleanup && npm run webpack:build:main mvnw

Npm is also used to manage CSS and JavaScript dependencies used in this application. You can upgrade dependencies by specifying a newer version in package.json. You can also run npm update and npm install to manage dependencies. Add the help flag on any command to see how you can use it. For example, npm help update.

The npm run command will list all of the scripts available to run for this project.

B)Additional Steps

Refer below sites for creating dev environment

  1. https://www.jhipster.tech/video-tutorial/

  2. https://www.jhipster.tech/creating-an-app/

3) https://github.com/mraible/jhipster6-demo/blob/master/demo.adoc

Service workers

Service workers are commented by default, to enable them please uncomment the following code.

<script>
  if ('serviceWorker' in navigator) {
    navigator.serviceWorker.register('./service-worker.js').then(function() {
      console.log('Service Worker Registered');
    });
  }
</script>

Note: workbox creates the respective service worker and dynamically generate the service-worker.js

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 few other things remaining to do for Leaflet that we won't detail here.

For further instructions on how to develop with JHipster, have a look at Using JHipster in development.

Building for production

Packaging as jar

To build the final jar and optimize the risingarjun 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 in your browser.

Refer to Using JHipster in production for more details.

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

Testing

To launch your application's tests, run:

./mvnw verify

Client tests

Unit tests are run by Jest and written with Jasmine. They're located in src/test/javascript/ and can be run with:

npm test

For more information, refer to the Running tests page.

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

You can run a Sonar analysis with using the sonar-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

or

For more information, refer to the Code quality page.

Using Docker to simplify development (optional)

You can use Docker to improve your JHipster development experience. A number of docker-compose configuration are available in the 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:

./mvnw -Pprod verify jib:dockerBuild

Then run:

docker-compose -f src/main/docker/app.yml up -d

For more information refer to Using Docker and Docker-Compose, this page also contains information on the docker-compose sub-generator (jhipster docker-compose), which is able to generate docker configurations for one or several JHipster applications.

Continuous Integration (optional)

To configure CI for your project, run the ci-cd sub-generator (jhipster ci-cd), this will let you generate configuration files for a number of Continuous Integration systems. Consult the Setting up Continuous Integration page for more information.

Deployment in Heroku

  1. Install Heroku client from https://devcenter.heroku.com/articles/heroku-cli#download-and-install

  2. Refer https://dashboard.heroku.com/apps/therisingarjun/deploy/heroku-git for using Heroku CLI After installation run below commands to deploy app $ heroku login $ jhipster heroku \$ heroku open

  3. Redeploy app $ heroku login $ git add . $ git commit -am "App Update" $heroku git:remote -a risingarjun set git remote heroku to https://git.heroku.com/risingarjun.git $git remote -v heroku https://git.heroku.com/risingarjun.git (fetch) heroku https://git.heroku.com/risingarjun.git (push) origin https://github.com/rasoftwaredivision/RisingArjun.git (fetch) origin https://github.com/rasoftwaredivision/RisingArjun.git (push) $git push heroku master

  4. Steps to access database; Resources Heroku postgres Dataclips Give title and sql query and run