Skip to content

Repository files navigation

DevHub

The official website for DevHub, a developer community focused on helping people learn, build, and connect with other developers. This repository contains the source code for the website, including the landing page, community rules, guides, resource library, blog, and partners page.

If you're new here, welcome! This README is designed to guide you from cloning the repository to making your first contribution, even if you've never worked with this codebase before.

About DevHub

DevHub is a developer community focused on helping programmers learn, collaborate, and grow together.

The website brings together community resources in one place, including:

  • 📚 Learning guides for developers
  • 🛠️ Curated tools and useful resources
  • 📖 Blog posts and tutorials
  • 🤝 Community information and onboarding guides
  • 📜 Rules, FAQs, and moderation guides
  • ❤️ Open-source contribution opportunities

If you're new to open source, this project is a great place to start because documentation improvements, bug fixes, and feature enhancements are all welcome.

What's in here

  • Landing page: introduction to DevHub and what the community offers
  • Pages: guides like Getting Started, How to Ask, How to Help, Code of Conduct, Contributing, Moderation Guide, Staff Roles, FAQ, and more
  • Resource library: curated tools and learning materials
  • Blog: write-ups from the community
  • Rules: the server and community rules in one place
  • Partners: communities and projects DevHub partners with

Tech Stack

Technology Purpose
Next.js React framework used to build the website
TypeScript Adds static typing to JavaScript
Tailwind CSS Utility-first CSS framework for styling
Reicon React Icon library
Vercel Deployment platform

You don't need to know all of these before contributing. Most changes only touch one or two of them at a time.

Getting Started

Follow the steps below to run the project on your own computer.

Don't worry if you've never worked with a Next.js project before—each step is explained.

Prerequisites

Before you begin, make sure you have the following installed:

  • Node.js 18 or later / Bun v1 or later
  • A package manager such as npm, bun, pnpm, or yarn
  • Git

Note

This guide uses bun for all examples. If you prefer npm, pnpm, or yarn, you can use the equivalent commands instead.

Step 1: Clone the repository

Clone the project from GitHub:

git clone https://github.com/open-devhub/website.git

Move into the project directory:

cd website

Step 2: Install dependencies

This project depends on several external packages. Install them using:

bun install

This may take a few minutes the first time.

Step 3: Start the development server

Run:

bun run dev

The development server will start locally.

Open your browser and visit http://localhost:3000

Whenever you save changes to the code, the browser automatically reloads so you can instantly see your updates.

Step 4: Verify Everything Works

Once the development server is running, open your browser and visit:

http://localhost:3000

You should see the DevHub homepage. Try navigating to a few pages to make sure everything loads correctly.

If you've made changes, save your files and verify that the browser updates automatically.

Project Structure

Below is an overview of the repository structure to help you locate important files and folders.

├── app/                  → Pages of the site (Next.js App Router)
│   ├── pages/            → Renders the guide pages (Getting Started, FAQ, etc.)
│   ├── blog/             → Blog listing + individual blog pages
│   ├── partners/         → Partners page
│   ├── resources/        → Resource library page
│   └── rules/            → Community rules page
├── components/           → Reusable React components
├── content/              → Site copy and structured data
│   ├── pages/            → Content for the guide pages
│   ├── blog/             → Blog content
│   ├── resources.ts      → Resource library data
│   └── rules.ts          → Community rules data
│   └── partners.ts       → DevHub partners data
├── lib/                  → Shared utility code
└── states/               → React states (zustand)

Contributing

We welcome contributions from developers of all experience levels, including first-time contributors!

A typical contribution workflow looks like this:

  1. Fork this repository to your GitHub account.
  2. Clone your fork locally.
  3. Create a new branch.
git checkout -b feature/my-new-feature
  1. Make your changes.
  2. Test your changes locally.
  3. Code quality check:
bun run lint
bun run format
  1. Commit your changes.
git commit -m "feat: add awesome feature"
  1. Push your branch.
git push origin feature/my-new-feature
  1. Open a Pull Request against the main branch describing what you changed and why.

New to open source? Look for issues tagged good first issue. These are picked specifically to be approachable for first-time contributors.

For a more detailed contribution guide, coding standards, and pull request expectations, please see CONTRIBUTING.md.

Community

Want to get involved? We'd love to have you!

License

Licensed under the GNU GPL v3.0 License. See the LICENSE file for details.

Contributors

Thanks to everyone who has contributed to this repository!

About

The official website for the DevHub developer community

Topics

Resources

Contributing

Stars

7 stars

Watchers

0 watching

Forks

Contributors

Languages