An open API service indexing awesome lists of open source software.

https://github.com/neuland-ingolstadt/neuland-website

Source code of the Neuland Ingolstadt e.V. website
https://github.com/neuland-ingolstadt/neuland-website

nextjs nextra react tailwind

Last synced: 2 months ago
JSON representation

Source code of the Neuland Ingolstadt e.V. website

Awesome Lists containing this project

README

          

# Neuland Ingolstadt e.V. Website

![Next.js](https://img.shields.io/badge/Next.js-black?style=for-the-badge&logo=next.js)
![React](https://img.shields.io/badge/React-black?style=for-the-badge&logo=react)
![TypeScript](https://img.shields.io/badge/TypeScript-black?style=for-the-badge&logo=typescript)
![Bun](https://img.shields.io/badge/Bun-black?style=for-the-badge&logo=bun)
![TailwindCSS](https://img.shields.io/badge/TailwindCSS-black?style=for-the-badge&logo=tailwindcss)

**A stylish, modern, and open-source website for Neuland Ingolstadt e.V. โ€“ built with Next.js, React, and Bun.**

[๐Ÿš€ Quick Start](#-quick-start) โ€ข [๐Ÿ“‹ Features](#-features) โ€ข [๐Ÿ“ฆ Technology Stack](#-technology-stack) โ€ข [๐Ÿค Contributing](#-contributing)

---

## ๐ŸŒŸ Overview

Neuland Ingolstadt e.V. Website is the digital home for our association, showcasing our activities, events, and community engagement. Built with the latest web technologies, it offers a beautiful, responsive, and accessible experience for members and visitors alike.

---

## ๐Ÿ“‘ Table of Contents

- [Overview](#-overview)
- [Quick Start](#-quick-start)
- [Features](#-features)
- [Technology Stack](#-technology-stack)
- [Development](#-development)
- [Code Quality](#-code-quality)
- [Contributing](#-contributing)
- [License](#-license)

---

## ๐Ÿš€ Quick Start

### Prerequisites

- [Node.js](https://nodejs.org/)
- [Bun](https://bun.sh/) (for development)

### Installation

```bash
# Clone the repository
git clone https://github.com/neuland-ingolstadt/neuland-website.git
cd neuland-website

# Install dependencies
bun install
```

### Development

Start the development server:

```bash
bun run dev
```

The site will be available at [http://localhost:3000](http://localhost:3000)

---

## ๐Ÿ“‹ Features

- **Modern UI/UX**: Clean, responsive design with dark/light mode
- **Blog**: Markdown-powered blog with tags, previews, and featured posts
- **Events**: Upcoming events section with calendar integration
- **Projects**: Showcase of association projects
- **Accessibility**: Keyboard navigation and WCAG compliance
- **SEO Optimized**: Fast, discoverable, and shareable
- **Open Source**: MIT licensed and community-driven

---

## ๐Ÿ“ฆ Technology Stack

| Component | Technology | Purpose |
|---------------|---------------------------|-----------------------------------------|
| **Frontend** | Next.js, React, TypeScript| Modern web app with SSR & SSG |
| **Styling** | Tailwind CSS, CSS Modules | Responsive, utility-first styling |
| **Bundler** | Bun | Fast JS runtime and package manager |
| **Markdown** | Contentlayer, MDX | Blog content and static site generation |
| **UI** | Custom Components | Reusable, accessible UI elements |

---

## ๐Ÿ› ๏ธ Development

- **Start Dev Server:**
```bash
bun run dev
```
- **Build for Production:**
```bash
bun run build
```
- **Start Production Server:**
```bash
bun run start
```

---

## ๐Ÿงน Code Quality

- **Linting:**
```bash
bun run lint
```
- **Formatting:**
```bash
bun run fmt
```

---

## ๐Ÿค Contributing

We welcome contributions from everyone! To get started:

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

**Code Style:**
- Use [Biome](https://biomejs.dev/) for linting and formatting
- Follow conventional commit messages

---

## ๐Ÿ“„ License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

---

**Made with โค๏ธ by [Robert Eggl](https://eggl.dev) and the Neuland Ingolstadt e.V. team**

[![GitHub stars](https://img.shields.io/github/stars/neuland-ingolstadt/neuland-website?style=social)](https://github.com/neuland-ingolstadt/neuland-website)
[![GitHub forks](https://img.shields.io/github/forks/neuland-ingolstadt/neuland-website?style=social)](https://github.com/neuland-ingolstadt/neuland-website)
[![GitHub issues](https://img.shields.io/github/issues/neuland-ingolstadt/neuland-website)](https://github.com/neuland-ingolstadt/neuland-website/issues)
[![GitHub pull requests](https://img.shields.io/github/issues-pr/neuland-ingolstadt/neuland-website)](https://github.com/neuland-ingolstadt/neuland-website/pulls)