Planck

A modern, powerful and open-source link shortener.
Explore the docs »

View Demo [WIP] · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact

About The Project

The aim of the project is to provide simple yet powerful tool to manage your short links. You can host your own Link shortener, to manage your URLs effectively, and have control over your data.

Built With

• Django
• Django Rest Framework
• React
• Docker

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• Docker: Get it from here.

Installation

1. Clone the Planck

git clone https://github.com/5parkp1ug/Planck.git

2. Build the docker container

docker-compose build app

Usage {WIP}

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

👽 Abhishek Shandilya Email

Project Link: https://github.com/5parkp1ug/Planck