Skip to content

Commit c922905

Browse files
docs(readme): overhaul README with full project documentation and setup guide
1 parent dcf4f84 commit c922905

1 file changed

Lines changed: 127 additions & 10 deletions

File tree

README.md

Lines changed: 127 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,137 @@
11
<h1 align="center" style="margin-top: 1em; margin-bottom: 3em;">
2-
<p><a href="https://reactdevske.netlify.app/"><img alt="logo" src="./public/reactdevske.svg" alt="reactdevske" width="125"></a></p>
3-
<p> <img src="https://media.giphy.com/media/hvRJCLFzcasrR4ia7z/giphy.gif" alt="Waving Hand" width="25px" height="25px"> Welcome to Reactjs Developer Community Kenya Website!</p>
2+
<p><a href="https://reactdevske.netlify.app/"><img alt="logo" src="./public/reactdevske.svg" width="125"></a></p>
3+
<p> <img src="https://media.giphy.com/media/hvRJCLFzcasrR4ia7z/giphy.gif" alt="Waving Hand" width="25px" height="25px"> React Developers Community — Kenya</p>
44
</h1>
55

6-
This is the repo for the showcase website of the React Developer Community in Kenya
6+
This repository contains the source for the community showcase website maintained by the React Developers Community (Kenya). The site is built with Next.js, TypeScript and Tailwind CSS, includes end-to-end tests with Playwright, and is container-ready using Docker.
77

8-
Check out the live version [HERE](https://reactdevske.vercel.app/)
8+
Live production: https://www.reactdevske.org/
99

10-
## Contributing to the project
10+
**Table of contents**
11+
- Overview
12+
- Features
13+
- Tech stack
14+
- Quickstart
15+
- Docker
16+
- Testing
17+
- Project structure
18+
- Contributing
19+
- License & contact
1120

12-
Contributions are always welcome!
21+
**Overview**
1322

14-
See [`contributing.md`](https://github.com/reactdeveloperske/reactdevske-website/blob/main/CONTRIBUTING.md) for ways to get started.
23+
This site showcases the community, upcoming events, contact information and resources for React developers in Kenya. It's intended as a community-maintained, easy-to-contribute codebase for public-facing content and event announcements.
1524

16-
Please adhere to this project's [`code of conduct`](https://github.com/reactdeveloperske/reactdevske-website/blob/main/CODE_OF_CONDUCT.md).
25+
**Features**
26+
- Responsive, accessible UI built with Next.js and Tailwind CSS.
27+
- Pages for home, about, contact, events, news, forum and members.
28+
- Reusable component library under `src/components`.
29+
- Playwright end-to-end tests (see `e2e/`).
30+
- Docker support for production-like local testing.
1731

18-
## Figma design file
32+
**Tech stack**
33+
- Next.js (pages-based) + React
34+
- TypeScript
35+
- Tailwind CSS
36+
- Playwright for E2E testing
37+
- Prettier, ESLint, and TypeScript for quality checks
1938

20-
Checkout the design file [`HERE`](https://www.figma.com/file/TVwnaDhBGeVdnVKdf6H91C/React-developers-community-website?node-id=741%3A976), feel free to use it to guide your contribution to our site.
39+
**Quickstart (local development)**
40+
41+
Prerequisites:
42+
- Node.js 16+ (or the version compatible with the `next` dependency)
43+
- npm or yarn
44+
45+
Install dependencies:
46+
47+
```bash
48+
npm install
49+
# or
50+
yarn install
51+
```
52+
53+
Run the development server:
54+
55+
```bash
56+
npm run dev
57+
# opens at http://localhost:3000
58+
```
59+
60+
Build for production:
61+
62+
```bash
63+
npm run build
64+
npm run start
65+
```
66+
67+
Useful scripts (from `package.json`):
68+
- `npm run dev` — starts Next.js in development mode
69+
- `npm run build` — produces a production build
70+
- `npm run start` — runs the production build
71+
- `npm run lint` — runs ESLint
72+
- `npm run test` — runs Playwright tests
73+
74+
**Docker**
75+
76+
This repository contains a `Dockerfile` and `docker-compose.yml` for running the app in a container.
77+
78+
Build & run with Docker Compose:
79+
80+
```bash
81+
docker-compose up --build
82+
```
83+
84+
The app will be available on the port configured in `docker-compose.yml` (default: 3000).
85+
86+
**Testing (Playwright)**
87+
88+
End-to-end tests are in the `e2e/` folder and are run using Playwright. To run tests locally:
89+
90+
```bash
91+
npm run test
92+
```
93+
94+
Playwright config is at `playwright.config.ts`.
95+
96+
**Project structure (important files & folders)**
97+
98+
- `public/` — static assets (images, manifest)
99+
- `src/pages/` — Next.js pages (routes)
100+
- `src/components/` — shared React components (Navbar, HeroHeader, Events, ContactUs, etc.)
101+
- `src/styles/` — global and module CSS (Tailwind entry)
102+
- `e2e/` — Playwright end-to-end tests
103+
- `Dockerfile`, `docker-compose.yml` — container configuration
104+
- `package.json`, `tsconfig.json`, `next.config.js` — build & tooling
105+
106+
If you want to explore components, start with:
107+
- `src/components/HeroHeader` — site hero
108+
- `src/components/Navbar` — navigation and menu
109+
- `src/components/Events` — events listing and display
110+
- `src/components/ContactUs` — contact form and footer
111+
112+
**Contributing**
113+
114+
Contributions are welcome. Please follow the contribution guidelines and community standards:
115+
116+
- Contribution guide: [CONTRIBUTING.md](CONTRIBUTING.md)
117+
- Code of conduct: [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
118+
119+
Suggested workflow:
120+
1. Fork the repo and create a feature branch.
121+
2. Run the dev server and make changes.
122+
3. Ensure TypeScript and lint checks pass: `npm run typecheck` and `npm run lint`.
123+
4. Add/update tests if applicable.
124+
5. Open a pull request with a clear description of your changes.
125+
126+
**Maintainers & contact**
127+
If you need help or want to propose changes not suitable for a PR, open an issue or reach out via the community channels listed in the repo.
128+
129+
**License**
130+
This project is open source — see the `LICENSE` file for details.
131+
132+
**Design resources**
133+
Figma design file used for the website is available here:
134+
https://www.figma.com/file/TVwnaDhBGeVdnVKdf6H91C/React-developers-community-website
135+
136+
---
137+
_Last updated: 2026-02-15_

0 commit comments

Comments
 (0)