Short.rs

A super-fast rust based URL shortner!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

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

About The Project

![Product Name Screen Shot][product-screenshot]

Short.rs is a super-fast rust based URL shortner. Capable of horizontal scaling and designed speifically for running in environments such as kubernetes, it's the perfect choice for any high-volume applications.

The current list of short URL's are stored in a redis backend, providing performant backend data storage, and easy scaling.

Built With

• Rust
• Hyper

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Running the docker-based environment, you will need to have docker installed. You will also need a redis server installed and setup.

Installation

docker run -p 80:80 -e LISTEN_ADDRESS="0.0.0.0:80" -e REDIS_CONNECTION_STRING="redis" savoiringfaire/shortener

Roadmap

• Support redis clusters.
• Style the pages a little better.

See the open issues for a full 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

Savoiringfaire - @savoiringfaire - contact@hhra.uk

Project Link: https://github.com/savoiringfaire/short.rs