Kizuren/uLinkShortener
1
0
Fork 0
mirror of https://github.com/Kizuren/uLinkShortener.git synced 2025-12-21 13:06:19 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
Code for https://u.kizuren.dev https://u.kizuren.dev
125 commits 4 branches 8 tags 1.5 MiB
Find a file
Exact
Kizuren 6e9e30f82c Fixed docker
2025-12-09 02:08:38 +01:00
.github Bump actions/checkout from 5 to 6 2025-12-01 03:39:21 +00:00
public added a folder to have docker build 2025-07-11 01:47:44 +02:00
src Biome format 2025-12-09 01:51:46 +01:00
.dockerignore finished µLinkShortener v2 2025-07-11 00:59:08 +02:00
.env.example finished µLinkShortener v2 2025-07-11 00:59:08 +02:00
.gitignore finished µLinkShortener v2 2025-07-11 00:59:08 +02:00
biome.json Biome format 2025-12-09 01:51:46 +01:00
bun.lock Fix tscongif.json error 2025-12-09 01:33:08 +01:00
docker-compose.dev.yml Update docker compose files 2025-12-09 01:16:22 +01:00
docker-compose.yml Fixed docker 2025-12-09 02:08:38 +01:00
Dockerfile Fixed docker 2025-12-09 02:08:38 +01:00
next.config.ts Biome format 2025-12-09 01:51:46 +01:00
package.json Biome format 2025-12-09 01:51:46 +01:00
postcss.config.mjs Biome format 2025-12-09 01:51:46 +01:00
README.md Update readme (removed unnecessary comments) 2025-12-09 01:17:06 +01:00
tsconfig.json Biome format 2025-12-09 01:51:46 +01:00

README.md

µLinkShortener v2

This project is the code behind u.kizuren.dev, a custom URL shortener. It uses Next.JS, MongoDB, and Docker for quick deployment.

Prerequisites

  • bun (optional, for development)
  • Docker & Docker Compose

Setup

  1. Clone the repository
  2. Define environment variables in the .env file (mongo connection string is not needed when using docker): 
    MONGO_URI=mongodb://<username>:<password>@<host>:<port>/<database>
MONGO_DB_NAME=<database>
NEXTAUTH_SECRET=VERY_SECURE_SECRET
NEXTAUTH_URL=http://localhost:3000

Running Locally

Without Docker

  1. Install dependencies: 
    bun i
  2. Build and run: 
    bun run build
bun run start

With Docker

docker compose up -d
docker compose up --build

The application will be available at http://localhost:3000

License

This project is licensed under the MIT License. See the LICENSE file for details.