Skip to content

spkrbox/vault

Repository files navigation

Vault - Simple File Sharing

Vault Logo

Share files with anyone, anywhere. No signup required.

Getting Started

Prerequisites

  • Node.js 18+
  • npm or yarn
  • Supabase account

Installation

  1. Clone the repository:
git clone https://github.com/macdontstop/vault.git
cd vault
  1. Install dependencies:
npm install
# or
yarn install
  1. Create a .env.local file in the root directory:
NEXT_PUBLIC_SUPABASE_URL=your_supabase_url
NEXT_PUBLIC_SUPABASE_ANON_KEY=your_supabase_anon_key
SUPABASE_STORAGE_BUCKET=your_bucket_name
UPSTASH_REDIS_REST_URL=your-redis-url
UPSTASH_REDIS_REST_TOKEN=your-redis-token
UPLOADS_PER_HOUR=10
  1. Run the development server:
npm run dev
# or
yarn dev
  1. Open http://localhost:3000 in your browser.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
  3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
  4. Push to the branch (`git push origin feature/AmazingFeature`)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

Share files with simplicity

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published