https://github.com/abdealijaroli/jaro
URL Shortener + P2P File Sharing 🦄 https://hub.docker.com/r/abdealijaroli/jaro
https://github.com/abdealijaroli/jaro
aws docker golang htmx postgres templ
Last synced: 9 months ago
JSON representation
URL Shortener + P2P File Sharing 🦄 https://hub.docker.com/r/abdealijaroli/jaro
- Host: GitHub
- URL: https://github.com/abdealijaroli/jaro
- Owner: abdealijaroli
- Created: 2024-07-28T06:22:06.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-07T13:27:14.000Z (over 1 year ago)
- Last Synced: 2025-05-03T07:37:39.128Z (about 1 year ago)
- Topics: aws, docker, golang, htmx, postgres, templ
- Language: Go
- Homepage: https://jaroli.me
- Size: 236 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Jaro
## Overview
Jaro is a CLI app dev tool for developers who are all things terminal. Jaro can help you get done two things right from your terminal - shorten links and securely transfer files p2p.
## Quick demo ✨
https://github.com/user-attachments/assets/154eff71-eace-4536-8644-1c6e7e16ee56
## Usage
To get started with Jaro, pull the Docker image from Docker Hub:
```
docker pull abdealijaroli/jaro
```
## Configuration
The application inside this container reads its configuration from a single environment variable. You need to provide this variable when running the container.
### Required Environment Variable
- **DB_URL**: PostgreSQL connection string (e.g., `postgresql://user:password@host:port/dbname`)
## 1. Run the server
To run the Jaro application, use the following command, replacing the `DB_URL` with your actual PostgreSQL connection string:
```
docker run -d --name jaro -e DB_URL=postgresql://user:password@host:port/dbname -p 8008:8008 abdealijaroli/jaro:latest
```
## 2. Shorten a link
```
docker run -d --name jaro -e DB_URL=postgresql://user:password@host:port/dbname -p 8008:8008 abdealijaroli/jaro:latest -s https://example.com
```
## 3. Transfer a file
```
docker run -d --name jaro -e DB_URL=postgresql://user:password@host:port/dbname -p 8008:8008 abdealijaroli/jaro:latest -t /path/to/your/file
```
## Features
- **Link Shortening**: Easily shorten URLs directly from your terminal.
- **File Transfer**: Transfer files without leaving your command line.
## Contributing
If you would like to contribute to Jaro, feel free to submit a pull request or open an issue.
## License
This project is open-source and available under the [MIT License](LICENSE).