|
1 | 1 | <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> |
4 | 4 | </h1> |
5 | 5 |
|
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. |
7 | 7 |
|
8 | | -Check out the live version [HERE](https://reactdevske.vercel.app/) |
| 8 | +Live production: https://www.reactdevske.org/ |
9 | 9 |
|
10 | | -## Contributing to the project |
| 10 | +**Table of contents** |
11 | 11 |
|
12 | | -Contributions are always welcome! |
| 12 | +- Overview |
| 13 | +- Features |
| 14 | +- Tech stack |
| 15 | +- Quickstart |
| 16 | +- Docker |
| 17 | +- Testing |
| 18 | +- Project structure |
| 19 | +- Contributing |
| 20 | +- License & contact |
13 | 21 |
|
14 | | -See [`contributing.md`](https://github.com/reactdeveloperske/reactdevske-website/blob/main/CONTRIBUTING.md) for ways to get started. |
| 22 | +**Overview** |
15 | 23 |
|
16 | | -Please adhere to this project's [`code of conduct`](https://github.com/reactdeveloperske/reactdevske-website/blob/main/CODE_OF_CONDUCT.md). |
| 24 | +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. |
| 25 | + |
| 26 | +**Features** |
| 27 | + |
| 28 | +- Responsive, accessible UI built with Next.js and Tailwind CSS. |
| 29 | +- Pages for home, about, contact, events, news, forum and members. |
| 30 | +- Reusable component library under `src/components`. |
| 31 | +- Playwright end-to-end tests (see `e2e/`). |
| 32 | +- Docker support for production-like local testing. |
| 33 | + |
| 34 | +**Tech stack** |
| 35 | + |
| 36 | +- Next.js (pages-based) + React |
| 37 | +- TypeScript |
| 38 | +- Tailwind CSS |
| 39 | +- Playwright for E2E testing |
| 40 | +- Prettier, ESLint, and TypeScript for quality checks |
| 41 | + |
| 42 | +**Quickstart (local development)** |
| 43 | + |
| 44 | +Prerequisites: |
| 45 | + |
| 46 | +- Node.js 16+ (or the version compatible with the `next` dependency) |
| 47 | +- npm or yarn |
| 48 | + |
| 49 | +Install dependencies: |
| 50 | + |
| 51 | +```bash |
| 52 | +npm install |
| 53 | +# or |
| 54 | +yarn install |
| 55 | +``` |
| 56 | + |
| 57 | +Run the development server: |
| 58 | + |
| 59 | +```bash |
| 60 | +npm run dev |
| 61 | +# opens at http://localhost:3000 |
| 62 | +``` |
| 63 | + |
| 64 | +Build for production: |
| 65 | + |
| 66 | +```bash |
| 67 | +npm run build |
| 68 | +npm run start |
| 69 | +``` |
| 70 | + |
| 71 | +Useful scripts (from `package.json`): |
| 72 | + |
| 73 | +- `npm run dev` — starts Next.js in development mode |
| 74 | +- `npm run build` — produces a production build |
| 75 | +- `npm run start` — runs the production build |
| 76 | +- `npm run lint` — runs ESLint |
| 77 | +- `npm run test` — runs Playwright tests |
| 78 | + |
| 79 | +**Docker** |
| 80 | + |
| 81 | +This repository contains a `Dockerfile` and `docker-compose.yml` for running the app in a container. |
| 82 | + |
| 83 | +Build & run with Docker Compose: |
| 84 | + |
| 85 | +```bash |
| 86 | +docker-compose up --build |
| 87 | +``` |
| 88 | + |
| 89 | +The app will be available on the port configured in `docker-compose.yml` (default: 3000). |
| 90 | + |
| 91 | +**Testing (Playwright)** |
| 92 | + |
| 93 | +End-to-end tests are in the `e2e/` folder and are run using Playwright. To run tests locally: |
| 94 | + |
| 95 | +```bash |
| 96 | +npm run test |
| 97 | +``` |
| 98 | + |
| 99 | +Playwright config is at `playwright.config.ts`. |
| 100 | + |
| 101 | +**Project structure (important files & folders)** |
| 102 | + |
| 103 | +- `public/` — static assets (images, manifest) |
| 104 | +- `src/pages/` — Next.js pages (routes) |
| 105 | +- `src/components/` — shared React components (Navbar, HeroHeader, Events, ContactUs, etc.) |
| 106 | +- `src/styles/` — global and module CSS (Tailwind entry) |
| 107 | +- `e2e/` — Playwright end-to-end tests |
| 108 | +- `Dockerfile`, `docker-compose.yml` — container configuration |
| 109 | +- `package.json`, `tsconfig.json`, `next.config.js` — build & tooling |
| 110 | + |
| 111 | +If you want to explore components, start with: |
| 112 | + |
| 113 | +- `src/components/HeroHeader` — site hero |
| 114 | +- `src/components/Navbar` — navigation and menu |
| 115 | +- `src/components/Events` — events listing and display |
| 116 | +- `src/components/ContactUs` — contact form and footer |
| 117 | + |
| 118 | +**Contributing** |
| 119 | + |
| 120 | +Contributions are welcome. Please follow the contribution guidelines and community standards: |
| 121 | + |
| 122 | +- Contribution guide: [CONTRIBUTING.md](CONTRIBUTING.md) |
| 123 | +- Code of conduct: [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) |
| 124 | + |
| 125 | +Suggested workflow: |
| 126 | + |
| 127 | +1. Fork the repo and create a feature branch. |
| 128 | +2. Run the dev server and make changes. |
| 129 | +3. Ensure TypeScript and lint checks pass: `npm run typecheck` and `npm run lint`. |
| 130 | +4. Add/update tests if applicable. |
| 131 | +5. Open a pull request with a clear description of your changes. |
| 132 | + |
| 133 | +**Maintainers & contact** |
| 134 | +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. |
| 135 | + |
| 136 | +**License** |
| 137 | +This project is open source — see the `LICENSE` file for details. |
| 138 | + |
| 139 | +**Design resources** |
| 140 | +Figma design file used for the website is available here: |
| 141 | +https://www.figma.com/file/TVwnaDhBGeVdnVKdf6H91C/React-developers-community-website |
| 142 | + |
| 143 | +--- |
| 144 | + |
| 145 | +_Last updated: 2026-02-15_ |
0 commit comments