Skip to content

rgrunbla/dissemin

 
 

Repository files navigation

dissem.in

Documentation Status Build Status Coverage Status

Web platform to help researchers upload their papers to open repositories.

dissem.in homepage

Getting started

A Vagrantfile is provided to quickly set up a VM running dissem.in and start hacking on the code.

  • git clone https://github.com/dissemin/dissemin
  • cd dissemin
  • vagrant plugin install vagrant-vbguest to install the VirtualBox guest additions plugin for Vagrant (if using VirtualBox)
  • vagrant up to create and provision the VM
  • vagrant ssh will let you poke into the machine and access its services (PostgreSQL, Redis, ElasticSearch). A tmux session is running so that you can check out the Celery and Django development server. You can attach it using tmux attach.

Dissem.in will then be available on your host machine at http://localhost:8080.

Note that, when rebooting the Vagrant VM / container, the Dissemin server will not be started automatically. To do it, once you have booted the machine, run vagrant ssh and then cd /dissemin && ./launch.sh and wait for some time until it says that Dissemin has started. The same holds for other backend services, you can check the very last lines of the provisioning/provision.sh to find out how to start them.

See the full installation instructions, which include alternative methods.

Contributing

Good first issues

A few issues at Github are marked as "Good first issue". These issues should be easily accessible and fixable without much knowledge about dissem.in internals and should be a good way to start contributing code.

These issues should be well documented and self-explanatory. If you feel like working on any open issues ("good first issue" or not), feel free to comment to say that you are working on this and ask details if the issue is incomplete.

Localization

Translations are hosted at TranslateWiki for an easy-to-use interface for translations and statistics.

Dissem.in uses the Django's standard localization system, which makes it easy to contribute new translations.

See the full details on how to contribute translations.

Writing an interface for a new repository

Writing an interface for a new repository, so that Dissem.in could upload to this repository, is very easy!

A full tutorial is available.

Links

License

dissem.in is released under the Affero General Public License. Full license is available in the LICENSE file.

About

Spot your own paywalled papers. Liberate them in one click.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 80.2%
  • HTML 12.8%
  • JavaScript 3.9%
  • CSS 2.5%
  • Shell 0.5%
  • Ruby 0.1%