Skip to content
This repository has been archived by the owner on Aug 6, 2021. It is now read-only.

Latest commit

 

History

History
25 lines (19 loc) · 2.13 KB

README.md

File metadata and controls

25 lines (19 loc) · 2.13 KB

idrop.link-backend strider build badge david dependency badge Codacy Badge

idrop.link - self hosted personal screenshot and file cloud to share with your friends, colleagues and family.

This app is meant to be hosted by yourself. So you stay in control of your data and security. To host the backend (the part of the app which stores and servers your drops in the internet) you need a webserver that supports at least Nodejs and MongoDB. (If you are unsure, check out uberspace.de.) idrop.link can also be hosted on heroku. For details check out this guide.

idrop.link also supports several ways to store your files:

  • plain filesystem (adviced if hosted on traditional server/webspace)
  • Amazon Web Services S3 content delivery network (mandatory if hosted on heroku)

Development

Before touching anything, run npm install --development in the root directory of the project. You should have grunt have a look over your files while developing: grunt watch. Before commiting it is mandatory to run grunt beautify. For everything you add, please provide tests. (See Makefile and ./test) If you have problems check if your mongodb copy runs under the default host, otherwise provide it like this:

env $MONGODB_URI='localhost:27017/idroplink' make test

The API documentation is available here.

Production

It is currently not advised to run this project in production mode.

Installation

Please see below for a detailed installation guide depending on your setup: