Giter Club home page Giter Club logo

bibspace's Introduction

README

BibSpace is an Online Bibtex Publications Management Software for Authors and Research Groups.

Archiving note

โš ๏ธ This repository is now archived and will be no longer maintained.

Build Status

Build Status Coverage Status

Native Installation

Using BibSpace with Docker

Testing

To run BibSpace tests (inside Docker), run the following commands.

docker-compose build
docker-compose  -f docker-compose.yml -f docker-compose.test.yml up

Running

To run BibSpace in production mode, run the following commands:

docker-compose build
docker-compose -f docker-compose.yml up -d

That's it! Point you browser to http://localhost:8083/ to open BibSpace.

You may stop the container with

docker-compose down

The MySQL data is stored in db_data, whereas preferences and stats in json_data.

Updating

General update instructions

Any update of native installation (no Docker)

  1. Make backup
  2. Replace code with the code from a newer version:
git clone --branch <version> https://github.com/vikin91/BibSpace.git

Whereas <version> equals the name of a branch or release tag, for example: v0.5.4.

  1. (Optional) Restore backup if any data got lost.

Any update of Docker installation

  1. Make backup
  2. Stop Docker containers docker-compose down
  3. Download docker-compose.yml file from Github
  4. Change the image version of BibSpace in docker-compose.yml Locate the following part and remove the build part.
  bibspace:
  build:
    context: .
    dockerfile: Dockerfile
  depends_on:
    - db

And add the image definition with respective version. For version 0.6.0 this will look as follows:

  bibspace:
  image: bibspace:0.6.0
  depends_on:
    - db
  1. Run with docker-compose up -d
  2. (Optional) Restore backup if any data got lost.

Update instructions for particular versions

From Version <=0.5.2 to 0.6.x

  1. Important: Update to version 0.5.3 or 0.5.4 first to enable JSON backups.
  2. Backup your data to the JSON format and make sure that data can be restored correctly.
  3. Replace code with version 0.6.0 and restore data from the JSON backup.

bibspace's People

Contributors

vikin91 avatar katrinleinweber avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.