Files
infra-xodivorce-in/README.md

84 lines
4.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
## Infra-xodivorce-in: powered by @xodivorce
### 👀 Preview
<img src="./src/assets/images/preview/infra-xodivorce-in-preview.png" alt="infra-xodivorce-in-preview">
#### A real-time map-based reporting system for campus infrastructure issues, built to improve visibility, accountability, and resolution efficiency.
[![status](https://img.shields.io/badge/status-active-brightgreen.svg?style=flat)](https://github.com/xodivorce/infra-xodivorce-in/)
[![version](https://img.shields.io/badge/version-v1.1.1-yellow.svg?style=flat)](https://github.com/xodivorce/infra-xodivorce-in/)
[![PRs](https://img.shields.io/badge/PRs-welcome-blue.svg?style=flat)](https://github.com/xodivorce/infra-xodivorce-in/)
> **🥰 Like this project? Please consider giving it a Star (🌟) on GitHub to show us your appreciation. Thank you!**
### 🧩 Offical Repositories
[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)](https://github.com/xodivorce/infra-xodivorce-in)
[![Gitea](https://img.shields.io/badge/Gitea-34495E?style=for-the-badge&logo=gitea&logoColor=5D9425)](https://gitea.neosubhamoy.com/xodivorce/infra-xodivorce-in)
### ⚡️ Technologies Used
![HTML5](https://img.shields.io/badge/html5-%23E34F26.svg?style=for-the-badge&logo=html5&logoColor=white)
![TailwindCSS](https://img.shields.io/badge/tailwindcss-%2338B2AC.svg?style=for-the-badge&logo=tailwind-css&logoColor=white)
![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E)
![Node.js](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white)
![PHP](https://img.shields.io/badge/php-%23777BB4.svg?style=for-the-badge&logo=php&logoColor=white)
![MySQL](https://img.shields.io/badge/mysql-%2300f.svg?style=for-the-badge&logo=mysql&logoColor=white)
![Git](https://img.shields.io/badge/git-%23F05033.svg?style=for-the-badge&logo=git&logoColor=white)
### 🛠️ Installation
Want to get started quickly? Follow the instructions below to install and run the project on your system.
1. **Clone the repository**
- Clone the repository to your local machine:
```bash
# Clone using SSH
git clone git@github.com:xodivorce/infra-xodivorce-in.git
# Or using HTTPS
git clone https://github.com/xodivorce/infra-xodivorce-in.git
```
2. **Set up your environment**
- Ensure you have [Node.js](https://nodejs.org/) version 14 or higher installed.
- Install [PHP](https://www.google.com/search?client=safari&rls=en&q=php&ie=UTF-8&oe=UTF-8), [MySQL](https://www.mysql.com), [Apache](https://www.apache.org), or [XAMPP](https://www.apachefriends.org).
3. **Install dependencies**
- Navigate to the project directory `src` and install the required packages:
```bash
# Go to the directory
cd src
# Install dependencies
npm install
```
4. **Configure Environment & Database**
- Set up your `.env` file based on `.env.example` file.
- Set up your MySQL database schema.
5. **Run the tool**
- Run the application from your terminal:
```bash
# Run Tailwind CSS using this command
npm run tcss
```
🐞 **Got Ideas or Spotted a Bug?**
Dont be shy! [*Open an issue*](https://github.com/xodivorce/infra-xodivorce-in/issues) to discuss new features, enhancements, or any bugs you find. Your feedback is golden!!
> <strong>⚠️ Frequently Asked Questions:</strong>
> <ul>
> <li><a href="FAQs/FAQ_EN.md" style="color:black;text-decoration:none;">🇺🇸 FAQ in English</a></li>
> <li><a href="FAQs/FAQ_IN.md" style="color:black;text-decoration:none;">🇮🇳 FAQ हिंदी में</a></li>
> <li><a href="FAQs/FAQ_RU.md" style="color:black;text-decoration:none;">🇷🇺 ЧаВо на Русском</a></li>
> <li><a href="FAQs/FAQ_IT.md" style="color:black;text-decoration:none;">🇮🇹 FAQ in Italiano</a></li>
> </ul>
### 📄 License
This project is licensed under a [**MIT License**](LICENSE.txt). You are free to use, modify, and distribute this software with proper attribution.
> 🧠 Follow me on [Instagram](https://www.instagram.com/xodivorce) or check out more projects at [xodivorce.in](https://www.xodivorce.in)
<br></br>
****
A open-source project - crafted with ❤️ by **xodivorce**. Made on Earth, by **Humans**.