Open Source Kigali — Website

Built in public • By the community • For the community

The official website for Open Source Kigali (OSK) — Rwanda’s growing open-source developer community.

This platform showcases community projects, events, learning resources, partnerships, and opportunities for contributors to collaborate and grow.

🌐 Live Website • 🐛 Report Bug •

---

📖 About the Project

This repository contains the source code for the official Open Source Kigali website.

The project exists to:

• Showcase OSK community initiatives
• Highlight open-source projects
• Share events and learning resources
• Help contributors join the community
• Support partnerships and collaborations

This repository itself is an open-source project.

Anyone can contribute by opening issues, suggesting improvements, or submitting pull requests.

---

✨ Features

• Fast and modern frontend powered by Vite
• Responsive UI with Tailwind CSS
• Reusable component architecture
• Mobile-friendly design
• Community-driven contributions
• Continuous deployment with Vercel
• Type-safe development using TypeScript

---

Tech Stack

Layer	Technology
Framework	React 18 + TypeScript
Build Tool	Vite
Styling	Tailwind CSS
Routing	React Router v6
HTTP	Native Fetch API
State Management	React Hooks (useState, useEffect)
Deployment	Vercel

---

Project Structure

src/
├── assets/          # Images and static assets
├── components/      # Reusable UI components
│   └── ui/          # UI primitives (Button, Badge, Card...)
├── constants/       # Static data arrays
├── hooks/           # Custom React hooks
├── lib/             # Utility functions and API helpers
├── pages/           # Route pages
├── types/           # TypeScript interfaces/types
└── App.tsx          # Router configuration

---

Getting Started

Prerequisites

Before running the project locally, ensure you have:

• Node.js 18+
• npm or yarn
• Git

---

Installation & Setup

1️⃣ Fork and Clone the Repository

 git clone https://github.com/Open-Source-Kigali/osk-frontend.git

2️⃣ Install Dependencies

npm install

3️⃣ Create Environment Variables

cp .env

4️⃣ Start Development Server

npm run dev

The application will run at:

http://localhost:5173

---

Environment Variables

Variable	Description	Required
VITE_API_BASE_URL	OSK backend API base URL	✅ Yes

---

Available Scripts

npm run dev        # Start development server
npm run build      # Build for production
npm run preview    # Preview production build locally
npm run lint       # Run ESLint
npm run typecheck  # Run TypeScript checks

---

Contributing

We welcome contributions from developers, designers, writers, and open-source enthusiasts of all skill levels.

See all contributors → CONTRIBUTORS.md

Please read:

CONTRIBUTING.md

before opening a pull request, do this.

---

New to Open Source?

Start with issues labelled:

good first issue

These issues are beginner-friendly, well-scoped, and reviewed quickly by maintainers.

---

Community & Contact

| Platform | Link | | -------- | ------------------------------------------------ | | | -------- | ------------------------------------------------ | | Discord | https://discord.com/invite/3dTFZSn6Tq/invite/osk | | LinkedIn | https://www.linkedin.com/company/open-source-kigali/?viewAsMember=true | | GitHub | https://github.com/open-source-kigali | | Email | mailto:opensourcekigali@gmail.com |

---

License

This project is licensed under the MIT License.

See:

LICENSE

for more information.

---

Built with ❤️ by the Open Source Kigali Community

Empowering African developers through open source.