The official website for Casbin. Casbin is an authorization library that supports access control models like ACL, RBAC, ABAC for Golang, Java, C#, JavaScript, Python, PHP and other languages.

This is a Next.js application built with Fumadocs, a modern documentation framework.

Visit the live site at: https://casbin.org

1. Git
2. Node.js: v20 or above
3. npm (comes with Node.js)

1. Clone the repository:

   git clone https://github.com/casbin/casbin-website-v3.git
   cd casbin-website-v3

2. Install dependencies:

   npm ci

3. Start the development server:

   npm run dev

4. Open http://localhost:3000 with your browser to see the result.

In the project, you can see:

• source.config.ts: Configuration for content source adapter
• src/lib/source.ts: Code for content source adapter, loader() provides the interface to access your content
• src/lib/layout.shared.tsx: Shared options for layouts

• 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 format - Format code with Prettier
• npm run format:check - Check code formatting
• npm run types:check - Type check the project

We welcome contributions! Here's how you can help:

For the configuration of the sidebar and navigation, refer to the Fumadocs documentation.

For the features that you may use when writing documents, please refer to Markdown Features.

If you find any issues or have suggestions, please open an issue on our GitHub Issues page.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes using Conventional Commits format
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Note: This project uses semantic-release for automated version management and package publishing. Please use conventional commit messages (e.g., feat:, fix:, docs:) for your commits.

To learn more about Next.js and Fumadocs, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API
• Learn Next.js - an interactive Next.js tutorial
• Fumadocs - learn about Fumadocs

This project is licensed under the Apache-2.0 License.