Kizuren/uLinkShortener
1
0
Fork 0
mirror of https://github.com/Kizuren/uLinkShortener.git synced 2025-12-21 21:16:17 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update readme (removed unnecessary comments)

Browse source
This commit is contained in:
Kizuren 2025-12-09 01:17:06 +01:00
parent 4c47f592e6
commit f955580abe
1 changed files with 6 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -3,13 +3,12 @@
This project is the code behind [u.kizuren.dev](https://u.kizuren.dev), a custom URL shortener. It uses Next.JS, MongoDB, and Docker for quick deployment. This project is the code behind [u.kizuren.dev](https://u.kizuren.dev), a custom URL shortener. It uses Next.JS, MongoDB, and Docker for quick deployment.
## Prerequisites ## Prerequisites
- Next.js - bun (optional, for development)
- MongoDB database (local or remote) - Docker & Docker Compose
- Docker & Docker Compose (optional, for containerized deployments)
## Setup ## Setup
1. Clone the repository 1. Clone the repository
4. Define environment variables in the `.env` file: 4. 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_URI=mongodb://<username>:<password>@<host>:<port>/<database>
MONGO_DB_NAME=<database> MONGO_DB_NAME=<database>
@ -23,7 +22,7 @@ This project is the code behind [u.kizuren.dev](https://u.kizuren.dev), a custom
1. Install dependencies: 1. Install dependencies:
``` ```
bun install bun i
``` ```
2. Build and run: 2. Build and run:
``` ```
@ -33,21 +32,11 @@ This project is the code behind [u.kizuren.dev](https://u.kizuren.dev), a custom
### With Docker ### With Docker
1. Build and run with docker compose:
```
docker-compose -f docker-compose-build.yml up --build
```
2. Use of pre-built image:
``` ```
docker compose up -d docker compose up -d
docker compose up --build
``` ```
The application will be available at http://localhost:3000
## Docker Deployment
1. Build and run containers:
```
docker-compose up --build
```
2. The application will be available at http://localhost:3000
## License ## License