urlinks

Completely free and fully open source link-in-bio tool. Like other link-in-bio tools, but everything is free and open source, cause nobody is paying to display 5 links on a website.

Warning

This project is still under heavy development. Use in production at your own risk.

Contributing

Contributions are always welcome!

See CONTRIBUTING.md to get started.

Don't forget to follow the Code of Conduct

Running locally

This is a Django Rest Framework and Vite project.

Using Nix (Recommended)

If you have Nix installed with flakes enabled, this is the easiest way to get started:

1. Clone the repository and cd into it
2. Allow direnv (if you use it): direnv allow
   • Or manually enter the shell: nix develop --impure
3. Set up your environment files:

   cp backend/.env.example backend/.env
   cp web/.env.example web/.env

4. Install dependencies:

   cd backend && uv sync && cd ..
   cd web && bun install && cd ..

5. Start all services:

   pc-up

This will automatically start PostgreSQL, run database initialization, and launch both the backend and frontend servers.

Available commands:

• pc-up - Start all services (PostgreSQL, Django, Vite)
• pc-down - Stop all services
• db-psql - Connect to the database
• db-reset - Drop and recreate the database

Manual Setup

If you're not using Nix, you can set up the project manually:

Django / Django Rest Framework

Using uv is recommended for this project.

1. After pulling the project, head over to the /backend/ directory, and run uv sync. This will initialize a virtual environment for the backend and install the dependencies.
2. Create a PostgreSQL database locally for freetree.
3. Fill out the .env according to the .env.example file, the .env should be located at the same place and level as the example one.
4. Migrate the tables by running python manage.py migrate.
5. Make sure pre commit hooks are installed by running pre-commit install.
6. Start the backend service with python manage.py runserver.

React / Vite

Using bun is recommended for this project.

1. After pulling the project, head over to the web directory and run bun install. This will install all dependencies for the project.
2. Fill out the .env according to the .env.example file, the .env should be located at the same place and level as the example one.
3. Start the frontend service with bun dev.

Useful URLs

After running the project, you can navigate to /admin on the backend for the Django admin panel with all registered models. You might need to have a superuser for this, you can create one using python manage.py createsuperuser.

You can also navigate to /api/docs on the backend for the automatically generated Swagger UI.