76 lines
1.8 KiB
Markdown
76 lines
1.8 KiB
Markdown
# SaifURL
|
||
|
||
Welcome to **SaifURL**, my personal URL shortening service! 🚀
|
||
|
||
## About the Project
|
||
|
||
SaifURL is a custom-built tool designed exclusively for my own use. It helps me shorten long and complex URLs into concise, manageable links. This service is tailored specifically to my needs, ensuring a streamlined and efficient experience.
|
||
|
||
### Features
|
||
|
||
- **Custom Short Links**: Quickly generate short, personal URLs for easier sharing and organization.
|
||
- **Simple Design**: A clean and intuitive interface designed just for me.
|
||
- **Fast and Reliable**: No delays—shorten URLs instantly.
|
||
- **Private Service**: This tool is solely for my personal use and not intended for public access.
|
||
|
||
### Built With
|
||
|
||
This project leverages the following technologies:
|
||
|
||
- **EJS** (Embedded JavaScript): Templating engine for dynamic HTML rendering.
|
||
- **JavaScript**: Core functionality and logic.
|
||
|
||
## Getting Started
|
||
|
||
Since this service is strictly for my personal use, here’s how I set it up for myself:
|
||
|
||
### Prerequisites
|
||
|
||
Ensure the following are installed on my system:
|
||
|
||
- [Node.js](https://nodejs.org/) (Latest LTS version recommended)
|
||
- [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/)
|
||
|
||
### Installation
|
||
|
||
1. Clone the repository:
|
||
|
||
```bash
|
||
git clone https://github.com/saifabdelrazek011/saifurl.git
|
||
```
|
||
|
||
2. Navigate to the project directory:
|
||
|
||
```bash
|
||
cd saifurl
|
||
```
|
||
|
||
3. Install the dependencies:
|
||
|
||
```bash
|
||
npm install
|
||
```
|
||
|
||
### Usage
|
||
|
||
1. Start the development server:
|
||
|
||
```bash
|
||
npm start
|
||
```
|
||
|
||
2. Open my browser and visit:
|
||
|
||
```
|
||
http://localhost:3000
|
||
```
|
||
|
||
3. Use the service to shorten my URLs as needed.
|
||
|
||
## License
|
||
|
||
This project is licensed under the [MIT License](LICENSE). Since this is a personal tool, I control its usage and modifications.
|
||
|
||
---
|
||
|
||
Let me know if you'd like any further changes!
|