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

https://github.com/dorsium/dorsium-org

Official documentation and technical guides for Dorsium blockchain. Community-driven platform for network information and governance resources.
https://github.com/dorsium/dorsium-org

blockchain community-governance cryptocurrency documentation nextjs opensource technical-documentation typescript web3

Last synced: about 1 month ago
JSON representation

Official documentation and technical guides for Dorsium blockchain. Community-driven platform for network information and governance resources.

Awesome Lists containing this project

README

          

# Dorsium Documentation & Community Platform

> Official documentation, community resources, and technical guides for the Dorsium blockchain ecosystem.

[![Website](https://img.shields.io/badge/website-dorsium.org-blue)](https://dorsium.org)
[![Discord](https://img.shields.io/badge/discord-join-7289da)](https://discord.com/invite/7QGZZCnQd8)
[![License](https://img.shields.io/badge/license-MIT-green)](LICENSE)

## 🌐 Live Website

**Visit:** [dorsium.org](https://dorsium.org)

This repository powers the Dorsium documentation website, providing comprehensive guides for miners, validators, developers, and community members.

---

## 📚 What's Inside

- **Documentation** - Technical guides for miners, validators, and node operators
- **Whitepaper** - Detailed technical specification and vision
- **Community Governance** - Information about network governance and proposals
- **Multi-language Support** - Available in English, Hungarian, Romanian, German, and Spanish

---

## 🏗️ Tech Stack

- **Framework:** [Next.js 16](https://nextjs.org) with App Router
- **Language:** TypeScript
- **Styling:** Tailwind CSS v4
- **Internationalization:** next-intl
- **Content:** MDX with Velite
- **Deployment:** Vercel

---

## 🚀 Getting Started

### Prerequisites

- Node.js 18+ and npm
- Git

### Installation

```bash
# Clone the repository
git clone https://github.com/dorsium/dorsium-org.git
cd dorsium-org

# Install dependencies
npm install

# Run development server
npm run dev
```

Open [http://localhost:3000/en](http://localhost:3000/en) in your browser.

### Available Scripts

```bash
npm run dev # Start development server
npm run build # Build for production
npm run start # Start production server
npm run lint # Run ESLint
npm run velite # Build content with Velite
```

---

## 🤝 Contributing

We welcome contributions from the community! Whether you're fixing typos, improving documentation, translating content, or enhancing the UI, your help is appreciated.

### How to Contribute

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

### Contribution Guidelines

- Read [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines
- Follow the existing code style and conventions
- Test your changes locally before submitting
- Write clear commit messages
- Update documentation if needed

### Good First Issues

Looking for a place to start? Check out issues labeled [`good first issue`](https://github.com/dorsium/dorsium-org/labels/good%20first%20issue).

---

## 📖 Project Structure

```
dorsium-org/
├── src/
│ ├── app/ # Next.js app directory
│ │ └── [locale]/ # Localized routes
│ ├── components/ # React components
│ ├── i18n/ # Internationalization config
│ └── lib/ # Utility functions
├── content/ # MDX content
│ ├── docs/ # Documentation articles
│ └── whitepaper/ # Whitepaper sections
├── messages/ # Translation files (JSON)
├── public/ # Static assets
└── scripts/ # Build scripts
```

---

## 🌍 Internationalization

The website supports multiple languages:

- 🇬🇧 English (`en`)
- 🇭🇺 Hungarian (`hu`)
- 🇷🇴 Romanian (`ro`)
- 🇩🇪 German (`de`)
- 🇪🇸 Spanish (`es`)

### Adding Translations

1. Edit translation files in `messages/{locale}.json`
2. Add translated content in `content/docs/{locale}/`
3. Test the locale: `/[locale]/docs`

---

## 🐛 Bug Reports & Feature Requests

Found a bug or have an idea? We'd love to hear from you!

- **Report a bug:** [Create an issue](https://github.com/dorsium/dorsium-org/issues/new?template=bug_report.md)
- **Request a feature:** [Create an issue](https://github.com/dorsium/dorsium-org/issues/new?template=feature_request.md)
- **Ask a question:** [Join our Discord](https://discord.com/invite/7QGZZCnQd8)

---

## 📜 License

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

---

## 🔗 Links

- **Website:** [dorsium.org](https://dorsium.org)
- **Discord:** [Join our community](https://discord.com/invite/7QGZZCnQd8)
- **Email:** [hello@dorsium.com](mailto:hello@dorsium.com)

---

## ⚖️ Compliance Notice

Dorsium operates in compliance with EU regulatory frameworks, including MiCA (Markets in Crypto-Assets Regulation). This documentation platform provides technical information about network operations and does not constitute investment advice or financial promotion.

---


Made with ❤️ by the Dorsium Community