mirror/Hangar
2
0
Fork 0
mirror of https://github.com/HangarMC/Hangar.git synced 2024-11-21 01:21:54 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md (#1220)

Browse Source
This commit is contained in:
GabrielFJunkes 2023-05-03 07:18:48 +00:00 committed by GitHub
parent 58a48d5613
commit 5cb4e78906
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -25,6 +25,7 @@ Fork the project and pull it in your IDE.
* Docker is required in order to run the PostgreSQL database and the dummy email server * Docker is required in order to run the PostgreSQL database and the dummy email server
* Java 17 or higher * Java 17 or higher
* [pnpm] * [pnpm]
* mvn
* git * git
### Setting up ### Setting up
@ -34,7 +35,7 @@ To get the project running locally, you need to follow a few steps:
1. Get the dummy database and email server up and running. Move to the docker folder `cd docker` then run `docker-compose -f dev.yml up -d` (`-d` as an optional parameter 1. Get the dummy database and email server up and running. Move to the docker folder `cd docker` then run `docker-compose -f dev.yml up -d` (`-d` as an optional parameter
to run the containers in the background). to run the containers in the background).
Alternatively, if you are using IntelliJ you can press the green arrow in the `docker/dev.yml` file. Alternatively, if you are using IntelliJ you can press the green arrow in the `docker/dev.yml` file.
2. Run the Spring Boot application. You can do this in the CLI with `mvn spring-boot:run`, or if you're using IntelliJ, it is included in the run 2. Move to the `backend` directory: `cd ../backend`. In that directory, run `mvn spring-boot:run`, or if you're using IntelliJ, it is included in the run
configurations. configurations.
3. Move to the `frontend` directory: `cd ../frontend`. In that directory, run `pnpm install`. This will install all the needed Node modules. 3. Move to the `frontend` directory: `cd ../frontend`. In that directory, run `pnpm install`. This will install all the needed Node modules.
4. After the installation, run `pnpm run dev` in the frontend directory to initiate the build and launch. Changes you do to the frontend will be reloaded 4. After the installation, run `pnpm run dev` in the frontend directory to initiate the build and launch. Changes you do to the frontend will be reloaded