snapify-authentik/README.md

Snapify

The self-hostable Loom alternative.
Learn more »

Website - Issue - Bug report

Snapify allows you to record and share recordings asynchronously

• Make unlimited recordings of your tab, desktop, and any application
• Share recordings with anyone using a public link
• Delete or un-list recordings after a specific timeframe
• Upload and share existing to videos

Development

Setup

1. Clone the repo into a public GitHub repository (or fork https://github.com/MarconLP/snapify/fork). If you plan to distribute the code, make sure to comply with our LICENSE.md.

   git clone https://github.com/MarconLP/snapify.git
   

2. Go to the project folder

   cd snapify
   

3. Install packages with yarn

   npm i
   

4. Set up your .env file

   • Duplicate .env.example to .env
   • Use openssl rand -base64 32 to generate a key and add it under NEXTAUTH_SECRET in the .env file.
   • Fill in the other variables

5. Run (in development mode)

   npm run dev
   

E2E-Testing

Be sure to set the environment variable NEXTAUTH_URL to the correct value. If you are running locally, as the documentation within .env.example mentions, the value should be http://localhost:3000.

# In a terminal just run:
npm run test:e2e

Deployment

Vercel

Contributing

Please see our contributing guide at CONTRIBUTING.md

License

Distributed under the Sustainable Use License. See LICENSE.md for more information.