🚀 LaunchPad

🚧 Work in progress: This project is a work in progress and some features may not be fully implemented yet.

LaunchPad is a web application that allows you to create and manage cards with links to your favorite websites, self hosted services, or anything else you want to have quick access to.

📋 Features

Current features include:

• Cards with custom titles, images, and links.
• Administrator panel for configuration and card management.
• Password protection on the administration panel.

Future features may include:

• Editing and reordering cards.
• Easy backup and restore of data.
• Download favicon for links.

📷 Screenshots

📡 Running the project

💻 Development

This project requires bun.js to run, which is an alternative to node and npm that provides out-of-the-box support for TypeScript and other features.

You can install it with the following command:

Windows:

powershell -c "irm bun.sh/install.ps1 | iex"

Linux & macOS

curl -fsSL https://bun.sh/install | bash
source ~/.bashrc

After installing bun, you can follow these steps to run the project:

Clone the repository:

git clone https://github.com/Wiredista/launchpad.git
cd launchpad

Install dependencies:

bun install

Then run the project:

bun run src/index.ts

Web interface will be available at http://localhost:3000/.

Default password is changeme. You can change it on the admin panel.

⛅ Production

The recommended way to run the project in production is using Docker. You can build the image with the following command:

docker build -t launchpad https://github.com/Wiredista/launchpad.git#main

Then you can run the image with:

docker run -p 3000:3000 launchpad

Alternatively, you can use Docker Compose to run the project. To do so, follow these steps.

Create a docker-compose.yml file with the following content:

services:
  launchpad:
    build: https://github.com/Wiredista/launchpad.git#main
    ports:
      - "3000:3000"
    volumes:
      - ./data:/app/data

Then run the project with:

docker compose up -d

In both cases, the web interface will be available at http://localhost:3000/.

If you're running the project in a server, make sure to replace localhost with the server's IP address.

You may also want to use a reverse proxy like Nginx or Nginx Proxy Manager to handle SSL and other configurations.

🤝 Contributing

Contributions are welcome! Please submit issues or pull requests on GitHub.

📝 License

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