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
Before you begin, check that you have met the following requirements:
- Have
Rust/Docker/docker-compose
- You have a machine with
<Windows / Linux / Mac>
.
To install the Ulink, follow these steps:
NixOs
nix develop
docker-compose up
cargo run
Linux e macOS:
docker-compose up
cargo run
To contribute to Ulink, follow these steps:
- Fork this repository.
- Create a branch:
git checkout -b <branch_name>
. - Make your changes and commit them:
git commit -m '<commit_message>'
- Send to the original branch:
git push origin <branch_name> / <location>
- Create the pull request.
Alternatively, see the GitHub documentation on how to create a pull request.