cms

This is the backend services for synectiks college management system.

This application was generated using JHipster 5.1.0, you can find documentation and help at https://www.jhipster.tech/documentation-archive/v5.1.0.

Why did we choose jhipster

1. Generate the Model & Rest Services from ERD diagram and JDL. It generates stanbdardized code.
2. Reuse its JWT authentication , localization , internationilaztion inbuilt functionalties.
3. Most imporatnatly use its inbuilt liquibase for upgrade.

Service Architecture

Most of the business logic is implemented in graphQL interface interacting with common model & services.

Structure of the Project

Since some part of its model & rest part is generated from jhipster , it follows some common pattern of typical jhipster project. The jhipster specific source code & directories are as follows:

1. .mvn/wrapper - some custom jars that has some mvn commands written only for jhipster.
2. .jhipster -- This is area , where jhipster creates all the json file snapshots corresponding to the models. Jhipster maintains this area so that when we make changes in code
3. webpack -- jhipster maintains webpack build scripts to generate the UI . We dont use the jhipster generated UI for production. We have our own UI maintained in https://github.com/xformation/cms-ui.
4. Src -- All the java src code

Some important locations of most of our code base is :

src/model/ -- This is the location for our model jdl file and some grafql query scripts. model.jdl is the model file.

The graphql resolvers and mutation are in src/main/java/com/synectiks/cms/graphql/ folder.

Some of the common services , like academic subjects and syllabus setup etc are located in :

src/main/java/com/synectiks/cms/business/service/

A good point to refer an example service is to follow LectureService.java , where we are processing the entire academic calender.

Development Environent

Before you can build this project, you must install and configure the following dependencies on your machine:

1. [maven][]: We use maven for building dependencies. You can install maven from apache site.
2. [java] -- This is build and run by oracle jdk1.8 environment , you can install oracle jdk1.8 from oracle site
3. [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.
4. [Yarn][]: We use Yarn to manage Node dependencies. Depending on your system, you can install Yarn either from source or as a pre-packaged bundle.
5. We do backend development mostly inside the intelli jidea

Though we don't use jhipster generated UI , but the UI is much helpful for test purpose. So in build process we will mention UI building steps also. In production environment , we only build the java services.

How to build the application - dev environment

For backend build -- Simply run the following command ./mvnw for windows - mvnw This should build the entire application. Before starting the service , you need to start ElasticSearch application , the application uses ealsticsearch to index its records. To connect with database, you can make the following config changes inside - src/main/resources/config/application-dev.yml datasource: type: com.zaxxer.hikari.HikariDataSource url: jdbc:postgresql://localhost:5432/cms username: postgres password: postgres If you have a right postgresql database and elasticsearch database, the ./mvnw should be started properly.

To start the application with some sample data, you can import backup.sql file in your postgresql database as follows:

psql --host="localhost" --port="5432" --username="postgres" --password="postgres" --dbname="cms" --file="backup.sql"

The backup.sql is under the root directory of github.

To access the backend grapiql apis - http://localhost:8080/graphiql

The test script for graphiql is located at src/model/.

Build Jhipster frontend -- Just for tests and swagger api documentation access --

Install node as prerequisites .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.

yarn install

We use yarn scripts and [Webpack][] as our build system. To build the frontend UI , you can simply do Yarn start

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
yarn start

[Yarn][] 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 yarn update and yarn install to manage dependencies. Add the help flag on any command to see how you can use it. For example, yarn help update.

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

Managing UI library dependencies

For example, to add [Leaflet][] library as a runtime dependency of your application, you would run following command:

yarn add --exact leaflet

To benefit from TypeScript type definitions from [DefinitelyTyped][] repository in development, you would run following command:

yarn add --dev --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

To optimize the cms application for production, run:

./mvnw -Pprod clean package

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/*.war

Then navigate to http://localhost:8080 in your browser.

You can login as admin/admin

You can check the swagger API as http://localhost:8080/#/admin/docs

To check all the entities and test their dependencies , you can play with it by clicking the entity menu and accesiing entities. http://localhost:8080/#/entity/college

Testing

To launch your application's tests, run:

./mvnw clean test

Client tests

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

yarn test

UI end-to-end tests are powered by [Protractor][], which is built on top of WebDriverJS. They're located in src/test/javascript/e2e and can be run by starting Spring Boot in one terminal (./mvnw spring-boot:run) and running the tests (yarn run e2e) in a second one.

Other tests

Performance tests are run by [Gatling][] and written in Scala. They're located in src/test/gatling.

To use those tests, you must install Gatling from https://gatling.io/.

For more information, refer to the [Running tests 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 verify -Pprod dockerfile:build dockerfile:tag@version dockerfile:tag@commit

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)

We are maintaining our jenkin CI server, we will publish its anonymous access asap.