diff --git a/README.md b/README.md index bfb52c27..69b2ab02 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,36 @@ DevPath Logo

-Welcome to the official repository for the **DevPath India Community Website**. This platform is designed to foster collaboration, share resources, manage events, and connect developers within the DevPath India community. Built with the latest web technologies, it offers a modern, responsive, and interactive user experience. +

+ Contributors + Forks + Stargazers + Issues + License +

+ +

+ Welcome to the official repository for the DevPath India Community Website. This platform is designed to foster collaboration, share resources, manage events, and connect developers within the DevPath India community. Built with the latest web technologies, it offers a modern, responsive, and interactive user experience. +

+ +
+ +## 📑 Table of Contents + +- [🚀 Features](#-features) +- [🛠️ Tech Stack](#️-tech-stack) +- [📸 Screenshots](#-screenshots) +- [🏁 Getting Started](#-getting-started) + - [Prerequisites](#prerequisites) + - [Installation](#installation) + - [🔥 Local Firebase Configuration](#-local-firebase-configuration) +- [📜 Scripts](#-scripts) +- [🤝 Contributing](#-contributing) +- [💖 Code of Conduct](#-code-of-conduct) +- [📄 License & Brand Protection](#-license--brand-protection) +- [🌟 Major Contributors](#-major-contributors) + +--- ## 🚀 Features @@ -27,6 +56,16 @@ This project leverages a modern and powerful technology stack: - **Icons**: [Lucide React](https://lucide.dev/) - **Linting**: [ESLint](https://eslint.org/) +## 📸 Screenshots + +*(Add your screenshots here)* + +| Home Page | Dashboard | +| :---: | :---: | +| Home Page | Dashboard | + +> **Note**: These are placeholders. Please upload actual screenshots to the `public/` folder and link them here. + ## 🏁 Getting Started Follow these steps to set up the project locally on your machine. @@ -36,6 +75,7 @@ Follow these steps to set up the project locally on your machine. Ensure you have the following installed: - [Node.js](https://nodejs.org/) (Latest LTS version recommended) - [npm](https://www.npmjs.com/), [yarn](https://yarnpkg.com/), or [pnpm](https://pnpm.io/) +- [Git](https://git-scm.com/) ### Installation @@ -71,7 +111,10 @@ To run this project locally, you'll need your own Firebase project: - **Firestore**: Create a database in test mode (or apply the rules in `firestore.rules`). 3. **Register a Web App**: Add a "Web App" to your Firebase project to get your configuration object. 4. **Fill `.env.local`**: Copy the values from your Firebase config object into your `.env.local` file. -5. **Install Firebase CLI**: `npm install -g firebase-tools` +5. **Install Firebase CLI**: + ```bash + npm install -g firebase-tools + ``` 6. **Login & Use Project**: ```bash firebase login @@ -102,7 +145,7 @@ To run this project locally, you'll need your own Firebase project: ## 🤝 Contributing -We welcome contributions from the community! Please read our [Contributing Guidelines](CONTRIBUTING.md) for details on how to get started. +We welcome contributions from the community! Please read our [Contributing Guidelines](CONTRIBUTING.md) for details on how to get started. Don't forget to check our [good first issues](https://github.com/devpathindcommunity-india/DevPath-Web/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) if you're looking for a place to start! ## 💖 Code of Conduct @@ -120,7 +163,9 @@ This project is licensed under a custom **DevPath India Source-Available License --- -Built with ❤️ by the DevPath India Community. +

+ Built with ❤️ by the DevPath India Community. +

## 🌟 Major Contributors