habsi/authentik
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

website: add website development setup, update contribution guidelines on PR titles (#4852)

Browse Source 
Signed-off-by: Jens Langhammer <jens@goauthentik.io>
This commit is contained in:
Jens L
2023-03-06 20:27:05 +01:00
committed by GitHub
parent c0144c9bc1
commit c4a7648ce3
5 changed files with 37 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
website/developer-docs/setup/frontend-only-dev-environment.md → website/developer-docs/setup/frontend-dev-environment.md
View File

@ -6,10 +6,14 @@ If you want to only make changes on the UI, you don't need a backend running fro
### Prerequisites
- Node (any recent version should work, we use 16.x to build)
- Node (any recent version should work, we use 18.x to build)
- Make (again, any recent version should work)
- Docker and docker-compose
:::info
Depending on platform, some native dependencies might be required. On macOS, run `brew install node@18`, and for docker `brew install --cask docker`
:::
### Instructions
1. Clone the git repo from https://github.com/goauthentik/authentik

2
website/developer-docs/setup/full-dev-environment.md
View File

@ -24,7 +24,7 @@ poetry install # Install all required dependencies, including development depend
```
:::info
Depending on platform, some native dependencies might be required. On macOS, run `brew install libxmlsec1 libpq`, and for the CLI tools `brew install postgresql redis`
Depending on platform, some native dependencies might be required. On macOS, run `brew install libxmlsec1 libpq`, and for the CLI tools `brew install postgresql redis node@18`
:::
To configure authentik to use the local databases, we need a local config file. This file can be generated by running `make gen-dev-config`.

21
website/developer-docs/setup/website-dev-environment.md Normal file
View File

@ -0,0 +1,21 @@
---
title: Website development environment
---
If you want to only make changes to the website, you only need node.
### Prerequisites
- Node (any recent version should work, we use 18.x to build)
- Make (again, any recent version should work)
:::info
Depending on platform, some native dependencies might be required. On macOS, run `brew install node@18`
:::
### Instructions
1. Clone the git repo from https://github.com/goauthentik/authentik
2. Run `make website-install` to install the website development dependencies
3. Run `website-watch` to start a development server to see and preview your changes
4. Finally when you're about to commit your changes, run `make website` to run the linter and auto-formatter.