Repository files navigation

Biostar Central is aPython andDjango based collection of web applications that support scientific practice and education.

The goal of the project is to produce software with straightforward installation and minimal dependencies that works on any computing platform that supports Python. For each app the philosophy is that of decentralization and self hosting. We write our code to allow others to recreate the same services that we run.

Each web application may be deployed individually or in combination with the others. The following applications are currently feature complete:

• forum a web app that runs a Q&A forum inspired by StackOverflow, see:Biostars Q&A
• recipes a web app that can runs data analysis scripts, see:Bioinformatics Recipes

The code inBiostar Central requiresPython 3.6 or above.

Our installation instructions rely onconda though other alternatives for managing python environments are equally viable.

# Create a virtual environment.conda create -y --name engine python=3.6# Activate the python environment.conda activate engine# Clone the source server code and the recipe code.git clone https://github.com/ialbert/biostar-central.git# Switch to the biostar-engine directory.cd biostar-central# Install server dependencies.pip install -r conf/requirements.txt

The installation is now complete.

All server management commands are run throughmake.

To run the demonstration version of therecipes app execute:

make recipes demo

To run a demonstration version of theforum app execute:

make forum demo

Visithttp://127.0.0.1:8000/ to view the site.

All users listed in theADMINS attribute of the Djangosettings.pymodule will gain administritave privileges when the site is initialized. TheDEFAULT_ADMIN_PASSWORD attribute will be set as the default admin password.By default the value for both is:

admin@localhost

Use this username and password combination to log into the site as an administrator. Change theDEFAULT_ADMIN_PASSWORD for public facing installations.

The Makefile has several tasks that demonstrate the commands that may be run. Typically a series ofmake tasks may be run. For example

Initialize and run a newrecipes app.

make recipes serve

Initialize and run a demo version of the recipes app:

make recipes demo

Initialize and run an newforum app.

make forum serve

• forum,recipes: selects the app to run. It must be the first task in the list.
• demo: runs a demonstration version
• init: initializes the database schema
• serve: runs the app on the default port (localhost:8080)
• save: saves the current database content as a JSON fixture file
• load: loads the last database save file from a JSON fixture
• reset: resets the database (deletes all database content)
• hard_reset: runsreset then deletes all files in the media/spool folder

To run all tests type:

make test

To test therecipes app run:

make recipes test

To test theforum app run:

make forum test

Additional documentation for:

• Documentation for therecipes app
• Documentation for theforum app