Skip to content

svnket/quikploy

Repository files navigation

Quikploy

Quikploy is a lightweight, open-source tool for deploying static websites. It is designed to make the process of deploying static sites as simple as possible, with just one click. It's built using open source tools.


✨ Features

  • Static Site Focused: Optimized for deploying static sites (HTML, CSS, JS, etc.) with zero configuration.
  • Open Source: Built with transparency and community collaboration in mind.
  • Modern Stack: Leverages React, Tailwind CSS, and Shadcn for a sleek, responsive UI.
  • Scalable Backend: Uses PostgreSQL for data persistence and Redis + BullMQ for job queueing.
  • RustFS Integration: High-performance file system operations with Rust.

🛠 Tech Stack

Category Tools/Technologies
Frontend React, Tailwind CSS, Shadcn
Backend Node.js ,BullMQ, Redis
Database PostgreSQL
File System RustFS
Ops Docker, Docker Compose

🚀 Getting Started

Prerequisites


Installation

  1. Clone the repository:
 git clone https://github.com/sanketghosh/quikploy.git
 cd quikploy
  1. Start the services:
 docker compose up -d
  1. Install dependencies and start the app:
 pnpm install && pnpm run start
  1. Access Quikploy: Open your browser and navigate to http://localhost:5173.

📂 Project Structure

quikploy/
├── apps/
    ├── api-server/
    ├── auth-server/
    ├── build-server/
    ├── proxy-server/
    ├── web/
├── packages/
    ├── better-auth/
    ├── database/
    ├── eslint-config/
    ├── logger/
    ├── queue/
    ├── tailwind-config/
    ├── typescript-config/
    ├── ui/ # used in v1 of web
├── .env/
├── docker-compose.yml
└── README.md

🤝 Contributing

We welcome contributions! Here’s how you can help:

  1. Fork the repository and create a new branch.
  2. Make your changes and ensure tests pass.
  3. Submit a Pull Request with a clear description of your changes.

For major changes, please open an issue first to discuss what you’d like to change.


📜 License

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


Releases

No releases published

Packages

 
 
 

Contributors