Skip to content

README.md

Latest commit

 

History

History
83 lines (55 loc) · 2.2 KB

README.md

File metadata and controls

83 lines (55 loc) · 2.2 KB
GPUL Logo

GPUL Documentation Site

GitHub License pnpm Node.js

Documentation site for GPUL (Grupo de Programadores y Usuarios de Linux), served under the docs subdomain. Built with Docusaurus.

🚀 Getting Started

📋 Prerequisites

  • Node.js (version 22.0 or higher)
  • pnpm (version 10.0 or higher)
  • Git

🔧 Installation

  1. Clone the repository:
git clone https://github.com/gpul/web.git gpul-web
cd gpul-web
  1. Install dependencies:
pnpm install
  1. Start the development server:
pnpm start

The site will be available at http://localhost:3000.

📁 Project Structure

gpul-web/
├── docs/                # Documentation files
├── src/                 # Source files
│   ├── components/      # React components
│   ├── css/             # Custom CSS
│   └── pages/           # Additional pages
├── static/              # Static assets
└── docusaurus.config.js # Docusaurus configuration

🤝 Contributing

We welcome all contributions! Whether you're fixing bugs, improving documentation, or adding new features, your help is appreciated.

Quick Start

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

All changes will be reviewed by a member of the current GPUL board before being merged.

For more detailed information, please read our Contributing Guide.

📄 License

This project is licensed under the GPL v3 License - see the LICENSE file for details.

📫 Contact

For any questions or suggestions, please contact the GPUL team through our official channels.

Built with ❤️ by GPUL