Home Explore Help
Register Sign In
scossu
/
lakesuperior_legacy
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: 97ea394c2b
Branches Tags
lakesuperior...
/
README.rst

README.rst 2.2 KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364 
  1. LAKEsuperior
    2. 

  2. ============
    3. 

  3. 

  4. |build status|
    5. 

  5. 

  6. LAKEsuperior is an alternative `Fedora
    7. 

  7. Repository <http://fedorarepository.org>`__ implementation.
    8. 

  8. 

  9. Documentation
    10. 

  10. -------------
    11. 

  11. 

  12. The full documentation is maintained in `Read The Docs
    13. 

  13. <http://lakesuperior.readthedocs.io/>`__. Please refer to that for more info.
    14. 

  14. 

  15. Installation
    16. 

  16. ------------
    17. 

  17. 

  18. The following instructions are aimed at a manual install using this git
    19. 

  19. repository. For a hands-off install using Docker, see
    20. 

  20. :doc:`the setup documentation <setup>`.
    21. 

  21. 

  22. Dependencies
    23. 

  23. ~~~~~~~~~~~~
    24. 

  24. 

  25. 1. Python 3.5 or greater.
    26. 

  26. 2. A message broker supporting the STOMP protocol. For testing and
    27. 

  27.    evaluation purposes, `CoilMQ <https://github.com/hozn/coilmq>`__ is
    28. 

  28.    included with the dependencies and should be automatically installed.
    29. 

  29. 

  30. Installation steps
    31. 

  31. ~~~~~~~~~~~~~~~~~~
    32. 

  32. 

  33. 1. Create a virtualenv in a project folder:
    34. 

  34.    ``virtualenv -p <python 3.5+ exec path> <virtualenv folder>``
    35. 

  35. 2. Activate the virtualenv: ``source <path_to_virtualenv>/bin/activate``
    36. 

  36. 3. Clone this repo:
    37. 

  37.    ``git clone https://github.com/scossu/lakesuperior.git``
    38. 

  38. 4. ``cd`` into repo folder
    39. 

  39. 5. Install dependencies: ``pip install -r requirements.txt``
    40. 

  40. 6. Start your STOMP broker, e.g.: ``coilmq &``. If you have another
    41. 

  41.    queue manager listening to port 61613 you can either configure a
    42. 

  42.    different port on the application configuration, or use the existing
    43. 

  43.    message queue.
    44. 

  44. 7. Run ``./lsup-admin bootstrap`` to initialize the binary and graph
    45. 

  45.    stores
    46. 

  46. 8. Run ``./fcrepo``.
    47. 

  47. 

  48. Contributing
    49. 

  49. ------------
    50. 

  50. 

  51. This has been so far a single person’s off-hours project (with much
    52. 

  52. input from several sides). In order to turn into anything close to a
    53. 

  53. Beta release and eventually to a production-ready implementation, it
    54. 

  54. needs some community love.
    55. 

  55. 

  56. Contributions are welcome in all forms, including ideas, issue reports,
    57. 

  57. or even just spinning up the software and providing some feedback.
    58. 

  58. LAKEsuperior is meant to live as a community project.
    59. 

  59. 

  60. See :doc:`related document <contributing>` for further details onhow to fork,
    61. 

  61. improve, document and test the project.
    62. 

  62. 

  63. .. |build status| image:: http://img.shields.io/travis/scossu/lakesuperior/master.svg?style=flat
    64. 

  64.    :target: https://travis-ci.org/username/repo
    65.