Installation & Usage
About 228 wordsLess than 1 minute
2025-10-10
Environment Requirements
Before using Twilight, make sure your system meets the following prerequisites:
- Node.js >= 20
- pnpm >= 9
- Git
Install Node.js
Visit the official Node.js site and download the latest LTS release.
After installation, open your terminal or command prompt and confirm the versions:
node -v
npm -vIf version numbers appear, Node.js and npm are installed correctly.
Install pnpm
If you do not yet have pnpm, install it via npm:
npm install -g pnpmVerify the installation:
pnpm -vInstall Git
Download the appropriate Git release for your operating system from the Git website.
After installation, confirm the version:
git --versionProject Setup Steps
1. Clone the Repository
git clone https://github.com/Spr-Aachen/Twilight.git
cd Twilight2. Install Dependencies
pnpm install3. Configure the Blog
Before starting the project, update the configuration to match your needs:
- Edit
src/config.tsto customize global site settings. - Update site metadata, theme colors, hero banners, and social links.
- Configure translation options and optional page features as required.
4. Start the Development Server
pnpm devOnce the server starts, visit http://localhost:4321 in your browser to preview the site.
5. Build for Production
pnpm buildThe generated static files will be output to the dist directory, ready for deployment.
