Arcfile

✨ seamlessly simple, effortless temporary file sharing.

📱 Mobile Screenshot

Prerequisites

If using Docker:

• Docker installed on your system
• Docker Compose installed

If running manually:

• Go installed (version 1.23.5+ recommended)
• PostgreSQL installed and running

Running Arcfile

🐳 Using Docker

1. Clone the repository:

git clone https://github.com/nxrmqlly/arcfile.git
cd arcfile

2. Start the services:

docker-compose up -d --build

This will build and start both the database and the API service.

3. Stop the services:

docker-compose down

💻 Running Manually

1. Start PostgreSQL

• Ensure PostgreSQL is running locally with the following credentials:
  • User: youruser
  • Password: yourpassword
  • Database: yourdb
  • Port: 5432

If using psql, you can create the database manually:

psql -U youruser -c "CREATE DATABASE yourdb;"

2. Clone the repository:

git clone https://github.com/nxrmqlly/arcfile.git
cd arcfile

3. Set up environment variables: Rename .env.example to .env and update the values:

# Your PostgreSQL database connection string
DATABASE_URL=postgres://youruser:yourpassword@localhost:5432/yourdb

# Gin mode: log levels, basically
GIN_MODE=release

# Set to true to listen on all interfaces (0.0.0.0), or false for localhost only
HOST=true 

# Maximum upload size in MiB (Mebibytes) (default is 32 MiB)
MAX_UPLOAD_SIZE=32

4. Build and run the application:

go mod download
go build -o main ./cmd/api/main.go
./main

API Endpoints

After running the service, the API should be accessible at:

• Base URL: http://localhost:8080
• API Routes /api

Acknowledgments

• Thanks to Aryan Madan (web) for help with frontend

• Thanks to Big Phil for help with the database