kchauxs/url-shortener

A simple URL shorte in NestJS ✂️ 🔗

URL-Shortener ✂️ 🔗

A simple URL shorte

Technologies👨‍💻

• NestJS
• TypeScript
• SQLite
• TypeORM
• Nano-ID
• Class-validator
• Class-transformer

Feactures 🦸

• Shorten a URL
• Return shortened URL
• Seed
• Swagger documentation
• Dockerfile

Install

1. Clone project
2. yarn install
3. Clone the .env.template file and rename it to .env
4. Change environment variables
5. Running the app yarn start:dev

Install on docker 🐋

Build the image

docker build -t url-shortener-api .

Create a container based on the image 📦

docker run -p 3033:3033 -d --name my-api url-shortener-api

Run SEED

curl -X 'GET' 'http://localhost:3033/api/v1/seed' -H 'accept: */*'

Swagger documentation

http://localhost:3033/api