Overview

The Project Segfault website is a web application built on Ghost CMS and Authentik authentication. It requires the installation of node.js, pnpm, and knowledge of Svelte. The website can be run locally for development purposes or in production using Docker Compose.

Features

• Ghost CMS deployment: The website is built on the Ghost CMS platform, allowing for easy content management and customization.
• Authentik authentication: The website uses Authentik for user authentication and authorization, providing a secure login system.
• Svelte development: The website utilizes the Svelte framework for front-end development, enabling a reactive and efficient user interface.

Installation

To install and run the Project Segfault website, follow these steps:

1. Install node.js on your system.
2. Install pnpm package manager.
3. Learn Svelte framework.
4. Add the required environment variables (listed below).
5. Clone the repository using git clone https://github.com/ProjectSegfault/website.
6. Change directory into the clone using cd ./website.
7. Install dependencies using pnpm i.
8. Run the development server using pnpm dev.
9. Open a browser and go to http://localhost:5173/ to see the website running locally.

For running the website in production, you have two options:

1. Docker: Install Docker and Docker Compose on your system. Add the required environment variables and run docker compose up -d in the source code directory (or compose.yml file if not building from source).
2. Local: Follow the steps in the “Developing” section, but use node build instead of pnpm dev. Expect the website to be available at http://localhost:3000/.

Summary

The Project Segfault website is a web application built on Ghost CMS and Authentik authentication. It offers features such as Ghost CMS deployment, Authentik authentication, and utilizes the Svelte framework for development. The installation process involves setting up the necessary dependencies, cloning the repository, and running the application locally or in production using Docker or locally with node.js.