Skip to content

NikTheDusky/briefkasten

Repository files navigation

๐Ÿ“ฎ Briefkasten

WIP Bookmarking application

๐Ÿš€ Getting Started

You'll need any type of database supported by Prisma, i.e. Postgresql, Mysql, etc. I've chosen Planetscale for my implementation.

For OAuth support, you'll also need any one of the providers supported by NextAuth.js.

  1. Clone the repository
$ git clone git@github.com:ndom91/briefkasten.git && cd briefkasten
  1. Install dependencies
$ npm install
  1. Copy the .env.example file, and fill in your copy of the environment variables.
$ cp .env.example .env
$ vim .env
  1. Start the development server!
$ npm run dev

๐Ÿ”— Bookmarklet

You can copy this link to your bookmarks bar, to add URLs to your instance!

๐Ÿ‘ท Contributing

This project is open to any and all contributions! Please stick to the ESLint / Prettier settings and I'll be happy to take a look at your issue / PR ๐Ÿ˜€

๐Ÿ“ License

MIT

About

๐Ÿ“ฎ Self hosted bookmarking app

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 96.6%
  • CSS 2.5%
  • Dockerfile 0.9%