|
| 1 | +[](https://www.fpbase.org) |
| 2 | + |
| 3 | +# FPbase: The Fluorescent Protein Database |
| 4 | + |
| 5 | +[](https://creativecommons.org/licenses/by-sa/4.0/) |
| 6 | +[](https://github.com/pydanny/cookiecutter-django/) |
| 7 | + |
| 8 | +https://www.fpbase.org |
| 9 | + |
| 10 | +## Installation for local development |
| 11 | + |
| 12 | +1. Clone repo and cd into directory |
| 13 | +``` |
| 14 | + $ git clone https://github.com/tlambert03/FPbase.git |
| 15 | + $ cd FPbase |
| 16 | +``` |
| 17 | +3. Create/activate environment with pipenv/virtualenv/conda (python 3 required) |
| 18 | +4. Install python requirements for local development |
| 19 | +``` |
| 20 | + $ pip install -r requirements/local.txt |
| 21 | +``` |
| 22 | +5. Install [Node.js](https://nodejs.org/en/) & npm (homebrew: `brew install node`) |
| 23 | +6. Install frontend requirements and [gulpjs](https://gulpjs.com/) |
| 24 | +``` |
| 25 | + $ npm install |
| 26 | + $ npm install gulp-cli -g |
| 27 | +``` |
| 28 | +7. Install a local postgreSQL database (for mac: [postgres.app](https://postgresapp.com/)) |
| 29 | +8. Create database, and apply migrations |
| 30 | +``` |
| 31 | + $ createdb fpbase |
| 32 | + $ python manage.py migrate |
| 33 | +``` |
| 34 | +9. If desired, load sample data (this may eventually break if the database schema changes enough). |
| 35 | +``` |
| 36 | + $ python manage.py loaddata fixtures/testdata.json.gz |
| 37 | +``` |
| 38 | +10. Compile assets and start server: |
| 39 | +``` |
| 40 | + $ gulp |
| 41 | +``` |
| 42 | + |
| 43 | +##### TODO |
| 44 | + |
| 45 | +* mutations / lineages |
| 46 | +* FRET views and FRET partners |
| 47 | +* weighted scoring based on user-selected attributes |
| 48 | +* user scoring/comments |
| 49 | +* user submit unpublished data |
| 50 | +* 2P absorption cross-section |
| 51 | +* photoswitchable chart |
| 52 | +* bleach comparisons within studies |
| 53 | +* scale spectra to EC/QY/brightness/excitation line |
| 54 | +* allow spectra/attributes to be embedded elsewhere |
| 55 | +* "add to comparison" option, with comparison page, sequence alignment |
| 56 | +* molecular weight |
| 57 | +* OSER data |
| 58 | +* Maturation data |
0 commit comments