Repository files navigation

The self-hostable Loom alternative.
Learn more »

Website -Issue -Bug report

• 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 videos

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

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

2. Go to the project folder

   cd snapify

3. Install packages with npm

   npm i

4. Set up your .env file

   • Duplicate.env.example to.env

   • Useopenssl rand -base64 32 to generate a key and add it underNEXTAUTH_SECRET in the .env file.

   • Fill in the other variables

     Configure DATABASE_URL

     1. OpenRailway and click "Start a New Project", and select Provision "MySQL".
     2. Select the MySQL App and copy theDATABASE_URL into the.env.

     Obtaining the Github API Credentials

     1. OpenGithub Developer Settings.
     2. Next, go toOAuth Apps from the side panel. Then click the "New OAuth App" button. Make sure to setAuthorization callback URL to<Snapify URL>/api/auth/callback/github replacing Snapify URL with the URI at which your application runs.
     3. Copy theClient ID asGITHUB_ID into the.env.
     4. Next, click "Generate a new client secret" and copy theClient secret asGITHUB_SECRET into the.env.

     Obtaining the AWS S3 API Credentials

     1. OpenB2 Cloud Storage Buckets.
     2. Create a new Bucket, make sure to set the bucket to private to make sure files are not being made publicly available.
     3. Copy theEndpoint asAWS_ENDPOINT and the Bucket name asAWS_BUCKET_NAME into the.env. Additionally you need to add theAWS_REGION, which is part of the endpoint and should look like this:us-east-005.
     4. Next, go toApplication Keys from the side panel. Then create a new Application Key, with full read and write access to the bucket.
     5. Copy thekeyID asAWS_KEY_ID and theapplicationKey asAWS_SECRET_ACCESS_KEY into the.env.

5. Set up the database using the Prisma schema

   npx prisma db push

6. Run (in development mode)

   npm run dev

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

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

Please see our contributing guide atCONTRIBUTING.md

Distributed under the AGPLv3 License. SeeLICENSE.md for more information.