-
Notifications
You must be signed in to change notification settings - Fork 8
docs: make README more beginner-friendly #53
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -1,6 +1,10 @@ | ||||||||||||||||||||||||||||||||||||||
| # DevHub | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| The official website for the DevHub developer community. Built with Next.js, TypeScript, and Tailwind CSS. | ||||||||||||||||||||||||||||||||||||||
| DevHub is a developer community focused on helping people learn, build, and connect with other developers. This repository holds the source for [devhub.vercel.app](https://devhub.vercel.app) — the community's website, including the landing page, guides, and resource library. | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| New to the project? This README walks you through what's here, how to run it locally, and how the code is organized, so you can start contributing without needing to already know the codebase. | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| Built with Next.js, TypeScript, and Tailwind CSS. | ||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+5
to
+7
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| ## What's in here | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
|
|
@@ -31,31 +35,60 @@ The official website for the DevHub developer community. Built with Next.js, Typ | |||||||||||||||||||||||||||||||||||||
| - **Icons** - Lucide | ||||||||||||||||||||||||||||||||||||||
| - **Deployment** - Vercel | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| If you're new to any of these, you don't need to be an expert to contribute — most changes only touch a small part of the stack at a time. | ||||||||||||||||||||||||||||||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| ## Getting Started | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| ### Prerequisites | ||||||||||||||||||||||||||||||||||||||
| Follow these steps to get the site running on your own machine. | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| ### 1. Check your prerequisites | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| You'll need: | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| - Node.js 18+ | ||||||||||||||||||||||||||||||||||||||
| - bun, npm, yarn, or pnpm | ||||||||||||||||||||||||||||||||||||||
| - **Node.js 18+** — [download here](https://nodejs.org/) if you don't have it. Run `node -v` to check your current version. | ||||||||||||||||||||||||||||||||||||||
| - A package manager: **bun**, **npm**, **yarn**, or **pnpm** (npm comes bundled with Node.js, so that's the easiest option if you're not sure which to pick) | ||||||||||||||||||||||||||||||||||||||
|
Comment on lines
-36
to
+49
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| ### Setup | ||||||||||||||||||||||||||||||||||||||
| ### 2. Get the code | ||||||||||||||||||||||||||||||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| If you plan to contribute, fork this repository first (click **Fork** at the top of the GitHub page), then clone your fork: | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| ```bash | ||||||||||||||||||||||||||||||||||||||
| # Clone the repo | ||||||||||||||||||||||||||||||||||||||
| git clone https://github.com/open-devhub/website | ||||||||||||||||||||||||||||||||||||||
| git clone https://github.com/YOUR_USERNAME/website | ||||||||||||||||||||||||||||||||||||||
| cd website | ||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| (If you're just running the site locally without contributing, you can clone this repo directly instead.) | ||||||||||||||||||||||||||||||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| # Install dependencies | ||||||||||||||||||||||||||||||||||||||
| ### 3. Install dependencies | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| ```bash | ||||||||||||||||||||||||||||||||||||||
| npm install | ||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| This downloads all the packages the project needs. It may take a minute the first time. | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| ### 4. Start the dev server | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| # Start the dev server | ||||||||||||||||||||||||||||||||||||||
| ```bash | ||||||||||||||||||||||||||||||||||||||
| npm run dev | ||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| Open [http://localhost:3000](http://localhost:3000) and you're in. | ||||||||||||||||||||||||||||||||||||||
| ### 5. Open it in your browser | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| Go to [http://localhost:3000](http://localhost:3000). The page will automatically reload as you edit files. | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| ## Project Structure | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| Here's a quick orientation to the main folders, in the order you're most likely to touch them: | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| - **`app/`** — The pages of the site, using Next.js's App Router. Each folder under `app/` generally maps to a URL path. | ||||||||||||||||||||||||||||||||||||||
| - **`components/`** — Reusable React components, split into `home/` (landing page sections), `site/` (shared layout pieces like the navbar and footer), `ui/` (generic building blocks like buttons and dialogs), and `bits/` (visual/animation effects). | ||||||||||||||||||||||||||||||||||||||
| - **`content/`** — Site copy and structured data (page listings, resources, community rules) kept separate from the components that render them. | ||||||||||||||||||||||||||||||||||||||
| - **`lib/`** — Shared utility code: animations, color helpers, config, and the markdown parser. | ||||||||||||||||||||||||||||||||||||||
| - **`hooks/`** — Custom React hooks. | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| Full tree, for reference: | ||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+82
to
+90
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||
| ├── 📁 .github | ||||||||||||||||||||||||||||||||||||||
| │ └── 📁 workflows | ||||||||||||||||||||||||||||||||||||||
|
|
@@ -158,17 +191,17 @@ Open [http://localhost:3000](http://localhost:3000) and you're in. | |||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| ## Contributing | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| We welcome contributions of all kinds: bug fixes, new features, documentation improvements, and design feedback. | ||||||||||||||||||||||||||||||||||||||
| We welcome contributions of all kinds: bug fixes, new features, documentation improvements, and design feedback — you don't need to be an expert in the stack to help out. | ||||||||||||||||||||||||||||||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| See [CONTRIBUTING.md](./CONTRIBUTING.md) for the full guide. The short version: | ||||||||||||||||||||||||||||||||||||||
| See [CONTRIBUTING.md](./CONTRIBUTING.md) for the full guide, including branch naming, commit message conventions, and the PR process. The short version: | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| 1. Fork the repo | ||||||||||||||||||||||||||||||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||
| 2. Create a branch (`git checkout -b feature/your-cool-feature`) | ||||||||||||||||||||||||||||||||||||||
| 3. Make your changes | ||||||||||||||||||||||||||||||||||||||
| 4. Run `npm run lint` | ||||||||||||||||||||||||||||||||||||||
| 5. Open a PR with a clear description | ||||||||||||||||||||||||||||||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| First time contributing to open source? Look for issues tagged [`good first issue`](https://github.com/open-devhub/website/issues?q=is%3Aopen+label%3A%22good+first+issue%22). | ||||||||||||||||||||||||||||||||||||||
| First time contributing to open source? Look for issues tagged [`good first issue`](https://github.com/open-devhub/website/issues?q=is%3Aopen+label%3A%22good+first+issue%22) — they're scoped to be approachable even if you've never opened a PR before. | ||||||||||||||||||||||||||||||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| ## Scripts | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
|
|
@@ -189,3 +222,9 @@ npm run format # Run Prettier | |||||||||||||||||||||||||||||||||||||
| ## License | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| Licensed under the GNU GPL v3.0 License. See the [LICENSE](./LICENSE) file for details. | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| ## Contributors | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||
| <a href="https://github.com/open-devhub/website/graphs/contributors"> | ||||||||||||||||||||||||||||||||||||||
| <img src="https://contrib.rocks/image?repo=open-devhub/website" /> | ||||||||||||||||||||||||||||||||||||||
| </a> | ||||||||||||||||||||||||||||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.