Skip to content
This repository has been archived by the owner on Dec 8, 2020. It is now read-only.
/ firefly Public archive

[WIP] Self-hosted personal bookmarking/archiving app

License

Notifications You must be signed in to change notification settings

poudel/firefly

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

59 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Introduction

There are countless other bookmarking services, apps etc. on the internet. Some are excellent pieces of software and are much better than firefly. I doubt firefly will ever achieve to being as big as some of it's alternatives.

I first started thinking of writing something because I wanted to get comfortable with Flask, MongoDB, pytest and to have an excuse to use Tachyons CSS library. I decided that it should be a bookmarking app because I've been looking for a self-hosted bookmarking web-app with minimal user interface.

Now that it has started shaping up, it is a good time to set a set of abstract goals or direction for the project.

  • Simple user interface.
  • Highly configurable.
  • Easy to install and upgrade.
  • Fast. Should be very fast.
  • Should emphasize on self-hosting.
  • The code should be well tested.
  • Should always be liberal when it comes to adding features that ease on organizing our daily digital life.
  • Should always be conservataive when it comes to drastically changing the user interface.
  • Should keep backwards compatibility.
  • Should be oriented to tech-savvy and power users.

Installation

  • Clone
  • Run pipenv install --dev --skip-lock
  • Run FLASK_ENV=development FLASK_APP=firefly pipenv run flask run

TODO

  • backup database (with encryption??)
  • restore from backup