sLink is a URL shortener application designed to make long URLs easier to manage and share. This project is built using Node.js and Express, and can be easily run using Docker or npm.
- Shorten long URLs
- Track click statistics
- Simple and easy-to-use dashboard
- API for programmatic access
You can quickly get sLink up and running using the pre-built Docker image:
-
Pull the Docker image from GitHub Container Registry:
docker pull ghcr.io/gyarbij/slink:latest
Or from Docker Hub:
docker pull gyarbij/slink:latest
Available tags:
latest: The most recent stable releasemain: The current state of the main branchdev: The development version- Semantic versioning tags (e.g.,
v1.0.0,v1.1.0)
To use a specific version, replace latest with the desired tag.
-
Run the Docker container:
docker run --name slink -p 36:36 ghcr.io/gyarbij/slink:latest
Or from Docker Hub:
docker run --name slink -p 36:36 gyarbij/slink:latest
To build and run the sLink application locally using Docker:
-
Clone the repository:
git clone https://github.com/Gyarbij/sLink.git cd sLink -
Build the Docker image:
docker build -t slink:local . -
Run the Docker container:
docker run --name slink -p 36:36 slink:local
To run the sLink application locally using npm:
-
Clone the repository:
git clone https://github.com/Gyarbij/sLink.git cd sLink -
Install dependencies:
npm install
-
Run the application:
npm start
The application will start on the default port 36.
Once the application is running, you can access the dashboard by navigating to http://localhost:36 in your web browser. Use the dashboard to create and manage shortened URLs.
TBD - More advanced usage instructions and screenshots.
- GET /:id - Redirect to the original URL
- GET /api/list - Get a list of shortened URLs
- DELETE /api/delete/:id - Delete a shortened URL
- POST /api/update/:id - Update a shortened URL
- POST /api/create - Create a new shortened URL
This project is licensed under the MIT License. See the LICENSE file for more details.