This project is currently in development and not yet production-ready.

Shortly is an in-development URL shortener, designed to have an intuitive mobile-first interface and a clean, modern design.

🚀 Features

• Mobile-first, responsive interface
• Clean and modern design
• Shorten and manage links
• Analytics and link tracking (planned)

🛠️ Running Locally for Development

# Clone the repository

git clone https://gitlab.beantech.uk/ollie/shortly.git
cd shortly

# Install dependencies

npm install

# Run locally

npm run dev

⚙️ Configuration

Create a .env file in the project root:

MONGODB_URI=<YOUR_DATABASE_URI>
AUTH_SECRET=<YOUR_SECRET>
AUTH_URL=http://localhost:3000

Refer to .env.example.

📆 Deployment

This project uses GitLab CI/CD to manage deployment:

main branch → Base Pipelines

pre-production branch → Publishing Pipelines

production branch → Deployment Pipelines

Refer to .gitlab-ci.yml for full pipeline configuration.

📁 Project Structure

shortly/
├── kubernetes/ # Kubernetes deployment template
├── src/ # Application source code
│ ├── app/ # Page and route files
│ ├── components/ # Page components
│ ├── interfaces/ # Interface definitions
│ ├── lib/ # Utility files
│ ├── models/ # Database models
│ ├── styles/ # CSS definitions
│ ├── types/ # Type definitions
├── scripts/ # Helper scripts for building
├── server/ # Server source code
├── .env.example # Environment variables
├── package.json # Project metadata and scripts
└── README.md

📄 License

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

🙋‍♂️ Contributing

Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.

📧 Contact

For support, please report an issue via discord.