Merge pull request #549 from 4ydan/makefile-devcon

markus2330 · web-flow · commit 6bd3a547ac87 · 2023-07-06T15:38:20.000+02:00
Makefile
diff --git a/Makefile b/Makefile
@@ -0,0 +1,117 @@
+.PHONY: all
+all: build
+
+.PHONY: help
+help: ## Show help for each of the Makefile recipes.
+	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z0-9_-]+:.*?## / {gsub("\\\\n",sprintf("\n%22c",""), $$2);printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)
+
+.PHONY: run-frontend
+run-frontend: build-frontend  ## Starts the frontend server.
+	cd frontend && npm run dev
+
+.PHONY: run-backend
+run-backend: build-backend  ## Starts the backend server.
+	cd backend && make run
+
+.PHONY: run-mdbook
+run-mdbook: build-mdbook ## Starts the mdbook server.
+	mdbook serve --open
+
+.PHONY: run-storybook
+run-storybook: build-storybook  ## Starts the storybook server.
+	cd frontend && npm run storybook
+
+# TEST
+
+.PHONY: test
+test: test-frontend test-backend test-mdbook  ## Tests everything + pre-commit
+	pre-commit
+
+.PHONY: test-frontend
+test-frontend: build-frontend ## Tests the frontend.
+	cd frontend && npm install && npm run format:check && npm run lint && npm run test
+
+.PHONY: test-backend
+test-backend: build-backend  ## Tests the backend.
+	cd backend && make test
+
+.PHONY: test-mdbook
+test-mdbook: build-mdbook  ## Tests the mdbook.
+	mdbook test
+
+.PHONY: test-storybook
+test-storybook:
+	@echo "\033[0;31m Not supported \033[0m" && exit 1
+
+# BUILD
+
+.PHONY: build
+build: install generate-api-types build-frontend build-backend build-storybook build-mdbook  # Builds everything.
+
+.PHONY: build-frontend
+build-frontend: install generate-api-types  ## Builds the frontend.
+	cd frontend && npm install && npm run generate-api-types && npm run build
+
+.PHONY: build-backend
+build-backend: install generate-api-types  ## Builds the backend.
+	cd backend && make build
+
+.PHONY: build-mdbook
+build-mdbook: install  ## Builds the mdbook.
+	mdbook build
+
+.PHONY: build-storybook
+build-storybook: install generate-api-types  ## Builds the storybook.
+	cd frontend && npm install && npm run build-storybook
+
+# MISC
+
+.PHONY: generate-type-doc
+generate-type-doc:  ## Generates typedoc.
+	cd frontend && npm install && npm run doc
+
+.PHONY: generate-api-types
+generate-api-types:  ## Generates typescript types.
+	cd frontend && npm run generate-api-types
+
+.PHONY: psql-r
+psql-r:  ## Remote connect to postgis, uses $POSTGRES_USER and $POSTGRES_DB
+	psql -h db -p 5432 -U $(POSTGRES_USER) $(POSTGRES_DB)
+
+.PHONY: pre-commit-all
+pre-commit-all:  ## Check all files with pre-commit.
+	pre-commit run --all-files
+
+.PHONY: distclean
+distclean: clean uninstall ## Cleans everything and uninstalls.
+
+.PHONY: clean
+clean: clean-frontend clean-backend clean-mdbook clean-storybook  ## Cleans everything.
+
+.PHONY: clean-frontend
+clean-frontend:  ## Removes node modules.
+	cd frontend && rm -rf node_modules
+
+.PHONY: clean-backend
+clean-backend:  ## Cleans the backend.
+	cd backend && make clean
+
+.PHONY: clean-mdbook
+clean-mdbook:  ## Removes the mdbook folder.
+	mdbook clean
+
+.PHONY: clean-storybook
+clean-storybook:  ## Removes the storybook static folder.
+	cd frontend && rm -rf storybook-static
+
+.PHONY: install
+install:  ## Install necessary packages within the source repo.
+	cd backend && make install
+	cargo install mdbook mdbook-mermaid
+	cargo install --git https://github.com/ElektraInitiative/mdbook-generate-summary mdbook-generate-summary
+
+.PHONY: uninstall
+uninstall:  ## Uninstalls dependencies within the source repo.
+	cd backend && make uninstall
+	cargo uninstall mdbook mdbook-mermaid
+	cargo uninstall mdbook-generate-summary
diff --git a/README.md b/README.md
@@ -8,17 +8,33 @@
 - Web: Firefox, Chromium
 - Larger mobile devices like tablets: Progressive Web App (PWA) Android 9+
 
+## Documentation
+
 Start reading in [/doc/architecture/README.md](/doc/architecture/README.md).
 The documentation is best viewed by running the following commands in the projects root folder:
 
 ```sh
-cargo install mdbook mdbook-mermaid
-cargo install --git https://github.com/ElektraInitiative/mdbook-generate-summary mdbook-generate-summary
-mdbook serve --open
+make run-mdbook
 ```
 
 Which will open [/doc/architecture/README.md](/doc/architecture/README.md) as first page.
 
+## Makefile commands
+
+Following commands exists:
+
+`run, test, build, clean`
+
+Following entities exist:
+
+`frontend, backend, mdbook, storybook`
+
+You can construct your commands now, e.g `run-backend`, `test-mdbook`, `build-storybook` or `clean-backend`
+
+Type `make help` to see all commands`
+
+**SOME OF THESE COMMANDS REQUIRE ENV VARIABLES TO WORK, LOOK AT [backend env variables](./doc/backend/01setup.md) or [frontend env variables](./frontend/README.md)**
+
 Important links:
 
 - [Web API Documentation](https://www.permaplant.net/doc/api/swagger/ui/)
diff --git a/backend/Makefile b/backend/Makefile
@@ -0,0 +1,31 @@
+.PHONY: run
+run:
+	cargo run
+
+.PHONY: test
+test: build
+	cargo test && cargo check && cargo clippy && cargo doc
+
+.PHONY: build
+build: install migrate
+	cargo build
+
+# Diesel setup, this makes sure that diesel will create the database if it doesn't exist yet and will run all migrations.
+# Diesel migrations, to bring the database up to date with the current schema.
+.PHONY: migrate
+migrate: install
+	LC_ALL=C diesel setup && LC_ALL=C diesel migration run
+
+.PHONY: clean
+clean:
+	cargo clean
+
+.PHONY: install
+install:
+	rustup component add rustfmt clippy
+	cargo install diesel_cli@2.0.1 --no-default-features --features postgres && cargo install typeshare-cli
+
+.PHONY: uninstall
+uninstall:
+	rustup component remove rustfmt clippy
+	cargo uninstall diesel_cli@2.0.1 --no-default-features --features postgres && cargo install typeshare-cli
diff --git a/backend/README.md b/backend/README.md
@@ -1,3 +1,3 @@
 # PermaplanT Backend
 
-Documentation about the backend including setup instructions can be found in `doc/backend/`.
+Documentation about the backend including setup instructions can be found [here](../doc/backend/01setup.md).
diff --git a/doc/CHANGELOG.md b/doc/CHANGELOG.md
@@ -33,7 +33,7 @@ Syntax: `- short text describing the change _(Your Name)_`
 - _()_
 - _()_
 - Improved user visible texts in map editor _(Thorben)_
-- _()_
+- DEV: Makefile added #549 _(4ydan)_
 
 ## 0.2.1 - UNRELEASED
 
diff --git a/doc/backend/01setup.md b/doc/backend/01setup.md
@@ -20,31 +20,29 @@ sudo -u postgres psql
 CREATE USER permaplant WITH CREATEDB PASSWORD 'permaplant';
 ```
 
-2. Install Diesel CLI:
+2. Install
 
-```shell
-cargo install diesel_cli --no-default-features --features postgres
-```
+To install dependencies.
 
-3. Run the diesel setup, this makes sure that diesel will create the database if it doesn't exist yet and will run all migrations.
-
-```shell
-LC_ALL=C diesel setup
+```sh
+make install
 ```
 
-4. Run diesel migrations, to bring the database up to date with the current schema.
+3. migrate
 
-```shell
-LC_ALL=C diesel migration run
+To update the database.
+
+```sh
+make migrate
 ```
 
-5. Install the typeshare cli to enable type safety between Rust and TypeScript:
+4. build
 
-```shell
-cargo install typeshare-cli
+```sh
+make build
 ```
 
-6. Start Keycloak
+5. Start Keycloak
 
 You can do one of the following two steps, the first one being the simpler one, but with less configuration options.
 
@@ -54,10 +52,12 @@ You can do one of the following two steps, the first one being the simpler one,
   - `AUTH_DISCOVERY_URI=http://localhost:8081/realms/PermaplanT/.well-known/openid-configuration`
   - `AUTH_CLIENT_ID=PermaplanT`
 
-7. Run the backend
+6. run
+
+To start the server
 
-```bash
-cargo run
+```sh
+make run
 ```
 
 ## Test server using Swagger

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`# PermaplanT Backend`
`2`	`2`
`3`		-Documentation about the backend including setup instructions can be found in `doc/backend/`.
	`3`	`+Documentation about the backend including setup instructions can be found [here](../doc/backend/01setup.md).`