Skip to content

setup-guide.md

Latest commit

 

History

History
58 lines (42 loc) · 2.67 KB

setup-guide.md

File metadata and controls

58 lines (42 loc) · 2.67 KB

Project Setup

This file describes the setup process of the repository, with the commands and steps needed to successfully recreate it.
It also serves as sort of a log for other developers to see in detail how things were created

General information

The repository is part of a Treecreate organization.
It utilizes Github Project, Issues and pull requests for task management.
Commits are made using git-cz, which replaces git commit and provides extra structure for making commits.
This is used in combination with semantic-release, which handles automatic creation of releases To use git cz, you have to install it globally with

npm install -g commitizen
npm install -g git-cz
commitizen init git-cz --save-dev --save-exact

If you install it locally, you will have to use npx git cz instead

For managing the monorepo, we use NX.
Install it with npm install -g nx (or install it locally and use it with npx nx ...)

If you encounter issues with creating apps, generating workspaces etc, make sure that you are using the latest version of Node, NX and the NX-Java plugin

Workspace setup

Create a new workspace within the root folder of the repository Run npx create-nx-workspace@latest webstore from outside of the repository root directory (it will create the workspace within the webstore directory)

Add docs explaining the setup of the workspace

Java Project setup

guide
Install a dependency for Java and Spring npm install --save-dev @nxrocks/nx-spring-boot It seems like the dependency uninstalls the nx-cloud one, so we install it again npm install --save-dev @nrwl/nx-cloud

Generate a Java app nx g @nxrocks/nx-spring-boot:app api
When prompted to, choose Maven, Jar, Java 11 and Java.
GroupId is your domain, in our case it's dk.treecreate
ArtifactId is the name of the app, api
For the package name, we combine the domain and the app name dk.treecreate.api
Description is quite self explanatory
For the dependencies we don't pass anything, and we will simply add them by hand. Why? Because I'm lazy and this is less error-prone

Angular Project Setup

Install a schematic for Angular npm install --save-dev @nrwl/angular

Generate a Angular app nx generate @nrwl/angular:app webstore
When prompted to, choose the following:
Stylesheet format: CSS
Router: Yes (We will need it in the future anyway, might as well add it)