Skip to content

ImGabe/ulink-backend

Repository files navigation

Ulink

Logo

Url shortener to reduce a long link write in Rust.

Forks Stargazers Issues MIT License

Adjustments and enhancements

The project is still under development and the next updates will focus on the following tasks:

  • Save urls in localStorage
  • Implement Register/Login
  • Implement custom Urls

💻 Pre-requisites

Before you begin, check that you have met the following requirements:

  • Have Rust/Docker/docker-compose
  • You have a machine with <Windows / Linux / Mac>.

🚀 Installing Ulink

To install the Ulink, follow these steps:

NixOs

nix develop
docker-compose up
cargo run

Linux e macOS:

docker-compose up
cargo run

📫 Contributing to Ulink

To contribute to Ulink, follow these steps:

  1. Fork this repository.
  2. Create a branch: git checkout -b <branch_name>.
  3. Make your changes and commit them: git commit -m '<commit_message>'
  4. Send to the original branch: git push origin <branch_name> / <location>
  5. Create the pull request.

Alternatively, see the GitHub documentation on how to create a pull request.