This commit is contained in:
2024-09-03 02:42:27 +05:30
parent bde2d88ddf
commit a021bfa479
16 changed files with 518 additions and 155 deletions

89
README.md Normal file
View File

@@ -0,0 +1,89 @@
# [Xeorl - Link Shortener and Management Tool](https://www.xeorl.buzz)
### Xeorl - The All-In-One, Fully Free to Use Advanced Link Shortener and Management Tool - Powered by ([@xodivorce](https://instagram.com/xodivorce)) ✨
[![status](https://img.shields.io/badge/status-active-brightgreen.svg?style=flat)](https://github.com/xeorl/xeorl-portfolio/)
[![version](https://img.shields.io/badge/version-v3.1.1-yellow.svg?style=flat)](https://github.com/xeorl/xeorl-portfolio/)
[![PRs](https://img.shields.io/badge/PRs-welcome-blue.svg?style=flat)](https://github.com/xeorl/xeorl-portfolio/)
<br></br>
### 📌 Tech Stack
Heres what fuels this site:
![HTML5](https://img.shields.io/badge/html5-%23E34F26.svg?style=for-the-badge&logo=html5&logoColor=white)
![CSS3](https://img.shields.io/badge/CSS-239120?&style=for-the-badge&logo=css3&logoColor=white)
![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E)
![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)
### 🛠️ How to Contribute: Lets Make Magic!
Want to jump in and sprinkle some magic on this project? Follow these steps:
1. **Fork and Clone**:
- Hit “Fork” at the top-right of the page to make your copy. Then clone it to your local machine:
```bash
git clone git@github.com:xeorl/xeorl.git
```
2. **Set Up Your Local Playground**:
- Move the project to your XAMPP `htdocs` folder:
```bash
mv xeorl /path/to/xampp/htdocs/
```
3. **Fire Up XAMPP**:
- Launch XAMPP and start Apache and MySQL:
```bash
# For XAMPP GUI:
open -a XAMPP
# Start Apache and MySQL in XAMPP Control Panel
```
4. **View Locally**:
- Open your browser and head to:
```bash
http://localhost/xeorl/htdocs/index.php
```
5. **Pro Tip**: Use a Self-Signed SSL for local development to keep everything smooth and secure with HTTPS. 🔐
6. **Create a Feature Branch**:
- Before diving in, create a new branch for your feature or fix:
```bash
git checkout -b cool-new-feature
```
7. **Work Your Magic**:
- Make your changes, test them, and get ready for a pull request.
8. **Commit and Push**:
- Once youre happy, commit and push your changes:
```bash
git add .
git commit -m "Add some cool feature"
git push origin cool-new-feature
```
9. **Open a Pull Request**:
- Go to the main repository and create a pull request. Let us know what youve done and why its awesome!
10. **Celebrate Your Contribution** 🎉:
- Enjoy the glory of your awesome contribution! We appreciate all your help and ideas.
🚀 **Got Ideas or Spotted a Bug?**
Dont be shy! [*Open an issue*](https://github.com/xodivorce/xeorl/issues) to discuss new features, enhancements, or any bugs you find. Your feedback is golden!!
- Lets create something epic together! 🌟
### 📝 License & Usage
Xeorl - Link Shortener and Management Tool is a Fully Open Sourced Project licensed under [**MIT LICENSE**](LICENSE). Anyone can view, modify, use (personal and commercial) or distribute it's sources without any attribution and extra permissions.
**🌟 Like this project? Please consider giving it a star to show your support!**
<br></br>
****
An Open Sourced Project - Crafted with ❤️ by **xodivorce**