π₯ MagLit - A super fast and easy-to-use Free and Open Source Privacy Respecting Encrypted Magnet/HTTP(s) Link Shortener with Password Protection π₯
π₯ Featured on Awesome Open Source and Awesome Privacy
β
100% Easy to use
β
100% Free and Open Source
β
100% Encrypted
β
100% Private
β
0% Personal Data stored
New Features
π MagLit now supports custom links!
π MagLit now lets you generate QR Codes for your lit links!
PREPARE
MagLit uses Firebase Firestore as a database. You must first create a new Firebase project, then a file with the name .env.local
in root directory of the project and fill the details as mentioned in .env.local.example
.
This step is a hard requeriment and any change to this file, requires a rebuild to the project from scratch (either through npm install/npm run dev or by using the docker steps)
Clone the project and install dependencies using:
npm install
You need npm or yarn installed for this.
Then, run the development server:
npm run dev
DOCKER:
# BUILD AND RUN IMAGE USING NPM
npm run docker
OR
# MANUALLY BUILD AND RUN IMAGE USING COMPOSE
sudo docker-compose build
sudo docker-compose up -d
Open http://localhost:3000 with your browser to see the result.
You can start editing the page by modifying pages/index.js
. The page auto-updates as you edit the file.
API routes can be accessed on http://localhost:3000/api/xxxxxx. This endpoint can be edited in pages/api/xxxxxx.js
.
The pages/api
directory is mapped to /api/*
. Read more about API routes.
![bmc-button](https://user-images.githubusercontent.com/25067102/154570688-9e143f2b-fee3-4b05-a9d2-a7a3013b2b51.png)