Enhance README Documentation for React Developer Community Kenya Website #147
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,18 +3,146 @@ | |
| <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> | ||
| </h1> | ||
|
|
||
| This is the repository for the showcase website of the React Developer Community in Kenya. | ||
|
|
||
| Check out the live version [HERE](https://reactdevske.vercel.app/) | ||
|
|
||
| --- | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| - [Project Overview](#project-overview) | ||
| - [Features](#features) | ||
| - [Getting Started](#getting-started) | ||
| - [Contributing to the Project](#contributing-to-the-project) | ||
| - [Technologies Used](#technologies-used) | ||
| - [Figma Design File](#figma-design-file) | ||
| - [FAQs](#faqs) | ||
| - [License](#license) | ||
| - [Contact](#contact) | ||
|
|
||
| --- | ||
|
|
||
| ## Project Overview | ||
|
|
||
| The React Developers Kenya Website is a platform designed to showcase the vibrant React.js developer community in Kenya. It serves as a hub for developers to connect, share knowledge, and collaborate on projects. The website is open-source and welcomes contributions from developers worldwide and across the country. | ||
|
|
||
| --- | ||
|
|
||
| ## Features | ||
|
|
||
| - Showcase of the React Developer Community in Kenya. | ||
| - Open-source and community-driven. | ||
| - Responsive design for seamless use across devices. | ||
| - Easy-to-navigate structure for contributors and users. | ||
| - Integration with GitHub for issue tracking and contributions. | ||
|
|
||
| --- | ||
|
|
||
| ## Getting Started | ||
|
|
||
| To get a local copy up and running, follow these steps: | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| Ensure you have the following installed: | ||
|
|
||
| - [Node.js](https://nodejs.org/) | ||
| - [Git](https://git-scm.com/) | ||
|
|
||
| ### Installation | ||
|
|
||
| 1. Clone the repository: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/reactdeveloperske/reactdevske-website.git | ||
| ``` | ||
|
|
||
| 2. Navigate to the project directory: | ||
|
|
||
| ```bash | ||
| cd reactdevske-website | ||
| ``` | ||
|
|
||
| 3. Install dependencies: | ||
|
|
||
| ```bash | ||
| npm install | ||
| ``` | ||
|
|
||
| 4. Start the development server: | ||
|
|
||
| ```bash | ||
| npm run dev | ||
| ``` | ||
|
|
||
| 5. Open your browser and navigate to `http://localhost:3000`. | ||
|
|
||
| --- | ||
|
|
||
|
|
||
| --- | ||
|
|
||
| ## Contributing to the Project | ||
|
|
||
| Contributions are always welcome! | ||
|
|
||
| ### How to Contribute | ||
|
|
||
| 1. Fork the repository. | ||
| 2. Create a new branch for your feature or bug fix. | ||
| 3. Make your changes and commit them with clear and concise messages. | ||
| 4. Push your changes to your forked repository. | ||
| 5. Submit a pull request to the main repository. | ||
|
|
||
| See [`CONTRIBUTING.md`](https://github.com/reactdeveloperske/reactdevske-website/blob/main/CONTRIBUTING.md) for more details. | ||
|
|
||
| Please adhere to this project's [`CODE_OF_CONDUCT.md`](https://github.com/reactdeveloperske/reactdevske-website/blob/main/CODE_OF_CONDUCT.md). | ||
|
|
||
| --- | ||
|
|
||
| ## Technologies Used | ||
|
|
||
| - **React.js**: Frontend framework. | ||
|
There was a problem hiding this comment. Add React,js as the frontend javascript library |
||
| - **Node.js**: Backend runtime. | ||
|
There was a problem hiding this comment. Add Next.js as the Frontend React Framework. |
||
| - **Tailwind CSS**: Styling. | ||
| - **GitHub Actions**: CI/CD. | ||
| - **Netlify/Vercel**: Deployment. | ||
|
There was a problem hiding this comment. Deployments are done on Vercel |
||
|
|
||
| --- | ||
|
|
||
| ## Figma Design File | ||
|
|
||
| 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. | ||
|
|
||
| --- | ||
|
|
||
| ## FAQs | ||
|
|
||
| ### 1. Who can contribute to this project? | ||
|
|
||
| Anyone! Whether you're a beginner or an experienced developer, your contributions are welcome. | ||
|
|
||
| ### 2. How do I report a bug? | ||
|
|
||
| You can report bugs by creating an issue in the [GitHub Issues](https://github.com/reactdeveloperske/reactdevske-website/issues) section. | ||
|
There was a problem hiding this comment. Also add that one has to go through the contribution guidelines (add a markdown link) for guidance |
||
|
|
||
| ### 3. Can I suggest new features? | ||
|
|
||
| Absolutely! Feel free to open a feature request in the [GitHub Issues](https://github.com/reactdeveloperske/reactdevske-website/issues) section. | ||
|
There was a problem hiding this comment. Also add that one has to go through the contribution guidelines (add a markdown link) for guidance |
||
|
|
||
| --- | ||
|
|
||
| ## License | ||
|
|
||
| This project is licensed under the MIT License. See the [`LICENSE`](https://github.com/reactdeveloperske/reactdevske-website/blob/main/LICENSE) file for details. | ||
|
|
||
| --- | ||
|
|
||
| ## Contact | ||
|
|
||
| React Developers Kenya Community | ||
| Email: [[email protected]](mailto:[email protected]) | ||
| Website: [reactdevske.org](https://www.reactdevske.org/) | ||
|
|
||
|
There was a problem hiding this comment. Add our kommunity page: https://kommunity.com/reactjs-developer-community-kenya-reactdevske/events/past Add our github sponsors page: https://github.com/sponsors/reactdeveloperske Add our opencollective page: https://opencollective.com/reactdevske |
||
| Feel free to reach out for any questions or contributions! | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
@festus-sulumeti
For the contribution guidelines section, emphasize on the detailed instructions that are available on the contribution guidelines. Some steps are missing from this summary which are very important and are addressed on the contribution guidelines,