Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 49 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,36 @@
<img src="public/logo.png" alt="DevPath Logo" width="250"/>
</p>

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.
<p align="center">
<a href="https://github.com/devpathindcommunity-india/DevPath-Web/graphs/contributors"><img src="https://img.shields.io/github/contributors/devpathindcommunity-india/DevPath-Web.svg?style=for-the-badge" alt="Contributors"></a>
<a href="https://github.com/devpathindcommunity-india/DevPath-Web/network/members"><img src="https://img.shields.io/github/forks/devpathindcommunity-india/DevPath-Web.svg?style=for-the-badge" alt="Forks"></a>
<a href="https://github.com/devpathindcommunity-india/DevPath-Web/stargazers"><img src="https://img.shields.io/github/stars/devpathindcommunity-india/DevPath-Web.svg?style=for-the-badge" alt="Stargazers"></a>
<a href="https://github.com/devpathindcommunity-india/DevPath-Web/issues"><img src="https://img.shields.io/github/issues/devpathindcommunity-india/DevPath-Web.svg?style=for-the-badge" alt="Issues"></a>
<a href="https://github.com/devpathindcommunity-india/DevPath-Web/blob/main/LICENSE"><img src="https://img.shields.io/github/license/devpathindcommunity-india/DevPath-Web.svg?style=for-the-badge" alt="License"></a>
</p>

<p align="center">
Welcome to the official repository for the <b>DevPath India Community Website</b>. 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.
</p>

<br />

## 📑 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)
Comment thread
devpathindcommunity-india marked this conversation as resolved.

---

## 🚀 Features

Expand All @@ -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 |
| :---: | :---: |
| <img src="public/placeholder-home.png" alt="Home Page" width="400"/> | <img src="public/placeholder-dashboard.png" alt="Dashboard" width="400"/> |

> **Note**: These are placeholders. Please upload actual screenshots to the `public/` folder and link them here.
Comment thread
devpathindcommunity-india marked this conversation as resolved.

## 🏁 Getting Started

Follow these steps to set up the project locally on your machine.
Expand All @@ -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

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand All @@ -120,7 +163,9 @@ This project is licensed under a custom **DevPath India Source-Available License

---

Built with ❤️ by the DevPath India Community.
<p align="center">
Built with ❤️ by the DevPath India Community.
</p>

## 🌟 Major Contributors

Expand Down