http://www.jhipsterpress.com/ LEARNING PROJECT:
First, I would like to thank Jon Rudell (https://github.com/ruddell). Without his help, http://www.jhipsterpress.com/ would not have been possible! Note that it takes +30 seconds to wake up http://www.jhipsterpress.com/ in Heroku free account.
When I started, I wanted to make an App that helped me (and hopefully others) to learn Jhipster and, at the same time, that would become an interesting project that could grow over time with different parts. This project is a live example of the solutions that are difficult to find elsewhere and you can see them in a working App. Check the Starting Point for a list of examples.
I thought about it as a collaborative project that should be interesting for other developers to join, at any point (you can mail me at [email protected]), either because you wanted to learn how we have done it (beginners) or propose new ideas to make it grow and excel. Moreover, you can download the App and create your own Website if you wish to do so.
The App is the combination of several sub-apps or parts: a newspaper with a blog and a meeting site (or grouping site). Let's start with a brief description of each part:
-
Newspaper: The admin can manage the FrontPage of the site placing news that he considers interesting. This news can be general news, or specific ones about main interests or activities that are important for him or his gorup. A profile or a group can have a Blog, post news and users can comment those posts that would be grouped with tags and topics that are related with the interests and activities of the meeting site.
-
Meeting site: A user can fill a profile detailing the activities or interest he has. He can follow other user with similar tastes, activities or sports, to join groups that meet together. A user, or group profile, can upload an Album with photographs. A profile can also receive messages and notifications.
-
WIP: Proposals: Think of a proposal as a general idea. A user thinks about something that wants to present to other users for consideration, so he fills a proposal. This proposal could be explained in a Post and it can be voted by other users, a group or the general visitor.
-
WIP: Bulletin Board: will be used to post offers and demands for things or services.
-
Other ideas: I have a few more ideas, but first I would like to start with the ones already mentioned here.
I'm not a programmer (actually I have a BA degree but always fascinated by computers), so I have the point of view of the inexperienced.
I learned Spring (thanks to a great teacher: John Purcell https://caveofprogramming.com/) and Angular (with a course from Maximilian Schwarzmüller: https://www.udemy.com/the-complete-guide-to-angular-2/). Then I learned Jhipster with these books:
- The JHipster Mini-Book 4.5 by Matt Raible. Now with a chapter on microservices!
- Full Stack Development with JHipster by Deepu K Sasidharan and Sendil Kumar. Get it on Packt and Amazon. https://www.safaribooksonline.com/library/view/full-stack-development/9781788476317/ A must read cause I'm going to explain things that are not fully enough covered there.
So this is the first step of the staircase. Anyone who reads these books should have, at least, the same level as I have. We should offer examples and solutions for the problems that are not covered in the books or the courses.
To get an idea of the entities and fields start by taking a look and understanding the JDL file: /src/main/scripts/raro.jh
Let me give you some examples. These might be a problem for:
STARTERS:
- How to import your project in STS Maven - Gradle:
- How to import a template like UNIFY for your project:
- How to allow HTML code inside a text field:
- How to show/hide information in the frontend depending on the user Role:
- How to open access to the REST Api:
- How to add static pages to the project:
- List screen shows only user’s data:
- Create a new Authority:
- How to connect PGAdmin4 to Heroku:
- How to configure the confirmation email in Heroku:
- How to add a new font-awesome icon:
- Project miscelanea:
BEGINNERS:
- How to avoid unauthorized calls to the API:
- How to change H2 Database from In-memory to Disk:
- How to change DTOs to load entities:
- How to change DTOs to load attributes of other entities:
- How to change DTOs to load attributes of not related entities:
- Translations: Text and Enums:
- Entity with double relation to another entity:
- How to put logic inside an observable:
INTERMEDIATE:
- How to change DTOs with MapStruct:
- How to use Filtering to show user's data only:
- How to use create new component pages on the frontend: Follows and BlockedUser case:
- How to create the FrontPage:
- How to combine two entities together: Post and Comments:
- Cascade deletion:*
- Different ways to block un-authorized code
- And more that will appear.
ADVANCED:
Once you download and follow the JHipster instructions, you will need to fill the database with data. Use the InsertsInPOSTGRESQLDatabaseV?BLANK.txt file in the root path with your H2 database and restart the App.
This application was generated using JHipster 5.3.0, you can find documentation and help at https://www.jhipster.tech/documentation-archive/v5.3.0.
Before you can build this project, you must install and configure the following dependencies on your machine:
- 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.
./gradlew
npm start
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.
Service workers are commented by default, to enable them please uncomment the following code.
- The service worker registering script in index.html
<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
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: Edit src/main/webapp/app/vendor.ts file:
import 'leaflet/dist/leaflet.js';
Edit src/main/webapp/content/css/vendor.css file:
@import '~leaflet/dist/leaflet.css';
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.
You can also use Angular CLI to generate some custom client code.
For example, the following command:
ng generate component my-component
will generate few files:
create src/main/webapp/app/my-component/my-component.component.html
create src/main/webapp/app/my-component/my-component.component.ts
update src/main/webapp/app/app.module.ts
To optimize the JhipsterPress08 application for production, run:
./gradlew -Pprod clean bootWar
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 build/libs/*.war
Then navigate to http://localhost:8080 in your browser.
Refer to Using JHipster in production for more details.
To launch your application's tests, run:
./gradlew test
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.
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
Then, run a Sonar analysis:
./gradlew -Pprod clean test sonarqube
For more information, refer to the Code quality page.
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:
./gradlew bootWar -Pprod buildDocker
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.
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.