This repository has been archived on 2024-05-31. You can view files and clone it, but cannot push or open issues or pull requests.
authentik/website/developer-docs/setup/website-dev-environment.md
Sandeep Gadhiya 4693c50701
website/docs: Troubleshooting Whitelist Email and Web-Dev Setup Docs (#6426)
* Whitelist email troubleshooting docs

* update preview website command

* Update website/docs/troubleshooting/whitelist_email.md

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Sandeep Gadhiya <sandeepgadhiya22@gmail.com>

* Update website/docs/troubleshooting/whitelist_email.md

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Sandeep Gadhiya <sandeepgadhiya22@gmail.com>

* Update website/docs/troubleshooting/whitelist_email.md

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Sandeep Gadhiya <sandeepgadhiya22@gmail.com>

* Update website/docs/troubleshooting/whitelist_email.md

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Sandeep Gadhiya <sandeepgadhiya22@gmail.com>

* Update website/docs/troubleshooting/whitelist_email.md

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Sandeep Gadhiya <sandeepgadhiya22@gmail.com>

* refactor policies section

* refactor policies section

---------

Signed-off-by: Sandeep Gadhiya <sandeepgadhiya22@gmail.com>
Co-authored-by: sandeepgadhiya <sandeep.gadhiya@turtlemint.com>
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
2023-08-09 10:06:41 -05:00

735 B

title
Website development environment

If you want to only make changes to the website, you only need node.

Prerequisites

  • Node.js (any recent version should work; we use 20.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@20 :::

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 make 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.