Portad

This is an open source URL Shortener service. I wanted to create a self-hosted app that can easily be deployed with docker. I wanted to have an internal system as well as something that could be public.

🚀 Features

• Modern interface
• Markdown support
• Custom domain support
• Frontend built with SvelteKit running on Bun
• Backend API service written in GoLang
• Docker containerization for easy deployment

Screenshots

Portus home page with dark theme

📋 Prerequisites

• Docker and Docker Compose
• Git (for submodule management)

🛠️ Installation

1. Clone the repository with submodules:

git clone --recursive https://github.com/unfaiyted/portad.git
cd portad

2. Initialize and update submodules:

git submodule update --init --recursive

🏗️ Development Setup

Frontend

cd frontend
bun install
bun run dev

Backend

cd backend
# Add backend setup instructions here

🐳 Docker Deployment

Build and run the entire stack:

docker compose up -d --build

Individual services can be built and run separately:

# Frontend only
docker compose up frontend

# Backend only
docker compose up backend

🏗️ Project Structure

portad/
├── docker-compose.yml
├── frontend/    # Frontend submodule
└── backend/     # Backend submodule

🤝 Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📝 License

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

🙏 Acknowledgments

• Built with Bun
• Docker containerization
• All contributors and maintainers