mirror of
https://github.com/xodivorce/xeorl.git
synced 2025-12-19 00:02:57 +05:30
98 lines
3.5 KiB
Markdown
98 lines
3.5 KiB
Markdown
# [Xeorl - Link Shortener and Management Tool](https://www.xeorl.buzz)
|
||
|
||
### 👀 Preview:
|
||
|
||
<img src="./images/xeorl_preview_one.png">
|
||
|
||
<br>
|
||
|
||
<img src="./images/xeorl_preview_two.png">
|
||
|
||
### Xeorl - The All-In-One, Fully Free to Use Advanced Link Shortener and Management Tool - Powered by [@xodivorce](https://instagram.com/xodivorce) ✨
|
||
[](https://github.com/xeorl/xeorl-portfolio/)
|
||
[](https://github.com/xeorl/xeorl-portfolio/)
|
||
[](https://github.com/xeorl/xeorl-portfolio/)
|
||
<br></br>
|
||
|
||
### 📌 Tech Stack
|
||
|
||
Here’s what fuels this site:
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
### 🛠️ How to Contribute: Let’s 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:xodivorce/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 you’re 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 you’ve done and why it’s 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?**
|
||
Don’t 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!!
|
||
|
||
- Let’s 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**
|