Skip to content

Spingular/spingular

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

79 Commits

.jhipster

.jhipster

 
 

ReadMe

ReadMe

 
 

gradle

gradle

 
 

miscelanea/SQLFakeData

miscelanea/SQLFakeData

 
 

src

src

 
 

webpack

webpack

 
 

.editorconfig

.editorconfig

 
 

.eslintignore

.eslintignore

 
 

.eslintrc.json

.eslintrc.json

 
 

.gitattributes

.gitattributes

 
 

.gitignore

.gitignore

 
 

.huskyrc

.huskyrc

 
 

.lintstagedrc.js

.lintstagedrc.js

 
 

.prettierignore

.prettierignore

 
 

.prettierrc

.prettierrc

 
 

.yo-rc.json

.yo-rc.json

 
 

Procfile

Procfile

 
 

README.md

README.md

 
 

angular.json

angular.json

 
 

build.gradle

build.gradle

 
 

gradle.properties

gradle.properties

 
 

gradlew

gradlew

 
 

gradlew.bat

gradlew.bat

 
 

package-lock.json

package-lock.json

 
 

package.json

package.json

 
 

postcss.config.js

postcss.config.js

 
 

proxy.conf.json

proxy.conf.json

 
 

settings.gradle

settings.gradle

 
 

sonar-project.properties

sonar-project.properties

 
 

tsconfig-aot.json

tsconfig-aot.json

 
 

tsconfig.e2e.json

tsconfig.e2e.json

 
 

tsconfig.json

tsconfig.json

 
 

tslint.json

tslint.json

 
 

Repository files navigation

LEARNING PROJECT: http://www.spingular.com/ (formerly jhipsterpress)

First, I would like to thank Jon Rudell (https://github.com/ruddell). Without his help, http://www.spingular.com/ would not have been possible! Note that it takes +30 seconds to wake up http://www.spingular.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 spingular@gmail.com), 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.

Starting point of the staircase.

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 Schwarzmuller: https://www.udemy.com/the-complete-guide-to-angular-2/). Then I learned Jhipster with these books:

Finally, I learned kubernetes with this great course created by Richard Chesterwood https://www.udemy.com/kubernetes-microservices

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:

BEGINNERS:

INTERMEDIATE:

ADVANCED:

SPECIFIC or not so general questions:

Do you already use this simple tool:https://www.diffchecker.com/diff?

DOWNLOAD & DATA INSERTIONS:

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.

REGULAR JHIPSTER INFO

LEARNING PROJECT: http://www.spingular.com/ (formerly jhipsterpress)

First, I would like to thank Jon Rudell (https://github.com/ruddell). Without his help, http://www.spingular.com/ would not have been possible! Note that it takes +30 seconds to wake up http://www.spingular.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 spingular@gmail.com), 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.

Starting point of the staircase.

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 Schwarzmuller: https://www.udemy.com/the-complete-guide-to-angular-2/). Then I learned Jhipster with these books:

Finally, I learned kubernetes with this great course created by Richard Chesterwood https://www.udemy.com/kubernetes-microservices

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:

BEGINNERS:

INTERMEDIATE:

ADVANCED:

SPECIFIC or not so general questions:

Do you already use this simple tool:https://www.diffchecker.com/diff?

DOWNLOAD & DATA INSERTIONS:

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.

REGULAR JHIPSTER INFO

Jhipster Version: spingular

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

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.

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.

PWA Support

JHipster ships with PWA (Progressive Web App) support, and it's disabled by default. One of the main components of a PWA is a service worker.

The service worker initialization code is commented out by default. To enable it, uncomment the following code in src/main/webapp/index.html:

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

Note: Workbox powers JHipster's service worker. It dynamically generates the service-worker.js file.

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: Edit src/main/webapp/app/vendor.ts file:

import 'leaflet/dist/leaflet.js';

Edit src/main/webapp/content/scss/vendor.scss file:

@import '~leaflet/dist/leaflet.css';

Note: There are still a 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.

Using Angular CLI

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

Building for production

Packaging as jar

To build the final jar and optimize the spingular application for production, run:

./gradlew -Pprod clean bootJar

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

./gradlew -Pprod -Pwar clean bootWar

Testing

To launch your application's tests, run:

./gradlew test integrationTest jacocoTestReport

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 gradle plugin.

Then, run a Sonar analysis:

./gradlew -Pprod clean check jacocoTestReport sonarqube

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:

./gradlew bootJar -Pprod jibDockerBuild

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.

About

Spingular Press Versión Jhipster 6.4.0

www.spingular.com/#/

Resources

Readme
Activity

Stars

8 stars

Watchers

2 watching

Forks

4 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages