Skip to content

README.md

Latest commit

 

History

History
113 lines (85 loc) · 3.71 KB

README.md

File metadata and controls

113 lines (85 loc) · 3.71 KB
Bulwark

Bulwark Website

The official website and documentation for Bulwark Webmail.
Built with Next.js and Tailwind CSS.

Overview

This repository contains the source code for the Bulwark project website, including:

  • Landing page - Product showcase with features, screenshots, tech stack, deployment guides, and FAQ
  • Documentation - Full docs covering installation, configuration, features, development, and deployment

Quick Start

Development

git clone https://github.com/bulwarkmail/website.git
cd website
npm install
npm run dev

Open http://localhost:3000 to view the site.

Production Build

npm run build
npm start

Project Structure

src/
├── app/                  # Next.js App Router pages
│   ├── page.tsx          # Landing page
│   ├── docs/             # Documentation pages
│   ├── install/          # Install redirect
│   └── api/              # API routes (docs search)
├── components/           # React components
│   ├── docs/             # Documentation components
│   └── *.tsx             # Landing page sections
└── lib/                  # Utilities (markdown processing, etc.)
docs/                     # Documentation content (Markdown)
├── getting-started/      # Installation, configuration, intro
├── features/             # Email, calendar, contacts docs
├── development/          # Architecture, contributing
├── deployment/           # Docker, manual, reverse proxy
├── guides/               # Customization, keyboard shortcuts
└── branding/             # Brand guidelines
public/                   # Static assets
├── branding/             # Logos, favicons
└── screenshots/          # Product screenshots

Tech Stack
Framework Next.js 16 with App Router
Language TypeScript
Styling Tailwind CSS v4
Markdown unified / remark / rehype pipeline
Icons Lucide React
Animation Framer Motion

Documentation

Documentation is written in Markdown under the docs/ directory. Files use gray-matter frontmatter for metadata:

---
title: Page Title
description: A brief description.
order: 1
---

# Content here

The documentation system supports:

  • GitHub Flavored Markdown
  • Syntax-highlighted code blocks with copy button
  • Auto-generated sidebar navigation
  • Full-text search

Contributing

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/my-change)
  3. Commit your changes (git commit -m 'Add my change')
  4. Push to the branch (git push origin feature/my-change)
  5. Open a Pull Request

Related