|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
|
|
|
2
|
+# Getting Started
|
|
|
3
|
+### 1. Fork this repository
|
|
|
4
|
+* Delegate a team member to be a repository host
|
|
|
5
|
+ * Repository host will fork the respective repository
|
|
|
6
|
+ * Repository host will [add each group member as a project-contributor](https://stackoverflow.com/questions/7920320/adding-a-collaborator-to-my-free-github-account)
|
|
|
7
|
+* `feat/dev` should branch from `master`
|
|
|
8
|
+* Each feature should branch from `feat/dev` with a naming convention of `feat/dev/featurename`.
|
|
|
9
|
+* As implementation is added to an individual-feature branch and proven to be stable, merge changes from `feat/dev/featurename` to `feat/dev`
|
|
|
10
|
+* As features are added to a development branch and proven to be integrable, merge changes from `feat/dev/` to `master`.
|
|
|
11
|
+
|
|
|
12
|
+### 2. Clone this repository from your forked repository
|
|
|
13
|
+* `git clone https://git.zipcode.rocks/ProjectRepositoryHostName/ProjectName`
|
|
|
14
|
+
|
|
|
15
|
+### 3. Architect the Application
|
|
|
16
|
+* Upon executing `jhipster` in the terminal, you are prompted tp architect the application:
|
|
|
17
|
+ 1. Which type of application would you like to create?
|
|
|
18
|
+ * monolith applicaiton
|
|
|
19
|
+ 2. What is the base name of your application?
|
|
|
20
|
+ * my-project-name
|
|
|
21
|
+ 3. What is your default java package name?
|
|
|
22
|
+ * `rocks.zipcode.io`
|
|
|
23
|
+ 4. Do you want to use the JHipster registry to configure, monitor and scale your project?
|
|
|
24
|
+ * yes
|
|
|
25
|
+ 5. Which type of database would you like to use?
|
|
|
26
|
+ * SQL (H2, MySQL, MariaDB, PostgreSQL, Oracle, MSSQL
|
|
|
27
|
+ 6. Which production database would you like to use?
|
|
|
28
|
+ * MySQL
|
|
|
29
|
+ 7. Which development database would you like to use?
|
|
|
30
|
+ * H2 with in-memory persistence
|
|
|
31
|
+ 8. You do want use the Spring cache abstraction?
|
|
|
32
|
+ * Yes, with Hazelcast implementation (distributed cache, for multiple nodes)
|
|
|
33
|
+ 9. Do you want to use Hibernate 2nd level cache?
|
|
|
34
|
+ * Yes
|
|
|
35
|
+ 10. Would you like to use Maven or Gradle for building the backend?
|
|
|
36
|
+ * Maven
|
|
|
37
|
+ 11. Which other technologies would you like to use?
|
|
|
38
|
+ * Nothing recommended here
|
|
|
39
|
+ 12. Which framework would you like to use for the client?
|
|
|
40
|
+ * Angular 6
|
|
|
41
|
+ 13. Would you like to enable SASS support using LibSass stylesheet preprocessor?
|
|
|
42
|
+ * yes
|
|
|
43
|
+ 14. Would you like to enable internationalization support?
|
|
|
44
|
+ * yes
|
|
|
45
|
+ 15. Please choose the native language of the application
|
|
|
46
|
+ * English
|
|
|
47
|
+ 16. Please choose additional languages to install
|
|
|
48
|
+ * Spanish
|
|
|
49
|
+ 17. Besides JUnit and Jest, which testing frameworks would you like to use?
|
|
|
50
|
+ * Protractor
|
|
|
51
|
+ 18. Would you like to install other generators from the JHipster Marketplace?
|
|
|
52
|
+ * Nothing recommended here
|
|
|
53
|
+
|
|
|
54
|
+### 4. Running the Application
|
|
|
55
|
+* From the root directory of the project execute `./mvnw` to run the application
|
|
|
56
|
+* Ensure that you can sign in as an administrator using
|
|
|
57
|
+ * username: `admin`
|
|
|
58
|
+ * password: `admin`
|
|
|
59
|
+* Ensure that you can sign in as a user using
|
|
|
60
|
+ * username: `user`
|
|
|
61
|
+ * password: `user`
|
|
|
62
|
+
|
|
|
63
|
+### 5. Viewing the Application
|
|
|
64
|
+* Navigate to [http://localhost:8080/](http://localhost:8080/)
|
|
|
65
|
+
|
|
|
66
|
+### 6. Design your project Entities
|
|
|
67
|
+* Using the [JdlStudio](https://start.jhipster.tech/jdl-studio/), create a UML representative of the application that you would like to build.
|
|
|
68
|
+* After designing your entities, download the resulting `jhipster-jdl.jh` by selecting the download button at the top right of the interface.
|
|
|
69
|
+* Place the `jhipster-jdl.jh` in the root directory of the application.
|
|
|
70
|
+* Execute the `jhipster-jdl.jh` file by navigating to the directory and running the command
|
|
|
71
|
+ * `yo jhipster:import-jdl jhipster-jdl.jh`
|
|
|
72
|
+ * Jhipster prompts you to make refactoring decisions; Read carefully, choose wisely
|
|
|
73
|
+ * Upon refactoring, Jhipster generates the respective the respective Angular and Spring code.
|
|
|
74
|
+
|
|
|
75
|
+### 7. Viewing the newly refactored Application
|
|
|
76
|
+* Navigate to [http://localhost:8080/](http://localhost:8080/) to ensure the application still runs as expected.
|
|
|
77
|
+
|
|
|
78
|
+### 8. Separate the Client from the Server
|
|
|
79
|
+* Fork the respective client-repository
|
|
|
80
|
+* Clone your newly forked client-repository
|
|
|
81
|
+* Copy the contents of the the `/src/main/webapp` directory of the monolith that was created in `Part 3`, to the root directory of the newly cloned client-repository
|
|
|
82
|
+
|
|
|
83
|
+### 9. Run the server
|
|
|
84
|
+* Execute `./mvnw` from the the root directory of the server project.
|
|
|
85
|
+
|
|
|
86
|
+### 10. Run the client
|
|
|
87
|
+* Execute `npm install`
|
|
|
88
|
+
|
|
|
89
|
+### 11. Ensure application still runs after separating monolith
|
|
|
90
|
+* Navigate to [http://localhost:8080/](http://localhost:8080/) to ensure the application is still behaving as expected.
|
|
|
91
|
+
|
|
|
92
|
+## Frequently Asked Questions
|
|
|
93
|
+* How do I kill a process listening on port 8080?
|
|
|
94
|
+ * `npx kill-port 8080`
|
Leon
5 lat temu