Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/openedx/edx-notes-api
edx-notes-api
https://github.com/openedx/edx-notes-api
backend-service
Last synced: about 5 hours ago
JSON representation
edx-notes-api
- Host: GitHub
- URL: https://github.com/openedx/edx-notes-api
- Owner: openedx
- License: agpl-3.0
- Created: 2014-11-10T19:37:29.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-12-16T06:32:09.000Z (11 days ago)
- Last Synced: 2024-12-16T07:34:00.925Z (11 days ago)
- Topics: backend-service
- Language: Python
- Homepage:
- Size: 881 KB
- Stars: 14
- Watchers: 119
- Forks: 55
- Open Issues: 5
-
Metadata Files:
- Readme: README.rst
- License: LICENSE.TXT
- Codeowners: .github/CODEOWNERS
- Authors: AUTHORS
Awesome Lists containing this project
README
edX Student Notes API |build-status|
####################################
This is a backend store for edX Student Notes.
Overview
********
The edX Notes API is designed to be compatible with the `Annotator `__.
Getting Started
***************
1. Install `ElasticSearch 7.13.4 `__.
2. Install the requirements:
.. code-block:: bash
make develop
3. Create index and put mapping:
.. code-block:: bash
make create-index
4. Run the server:
.. code-block:: bash
make run
Configuration
*************
``CLIENT_ID`` - OAuth2 Client ID, which is to be found in ``aud`` field of IDTokens which authorize users
``CLIENT_SECRET`` - secret with which IDTokens should be encoded
``ES_DISABLED`` - set to True when you need to run the service without ElasticSearch support.
e.g if it became corrupted and you're rebuilding the index, while still serving users
through MySQL
``ELASTICSEARCH_DSL['default']['hosts']`` - Your ElasticSearch host
Running Tests
*************
Install requirements::
make test.requirements
Start mysql/elasticsearch services::
make test-start-services
Run unit tests::
make test
Run quality checks::
make quality
How To Resync The Index
***********************
edX Notes Store uses `Django elasticsearch DSL `_ which comes with several management commands.
Please read more about ``search_index`` management commands
`here `_.
License
*******
The code in this repository is licensed under version 3 of the AGPL unless
otherwise noted.
Please see ``LICENSE.txt`` for details.
How To Contribute
*****************
Contributions are very welcome.
Please read `How To Contribute `_ for details.
Reporting Security Issues
*************************
Please do not report security issues in public. Please email [email protected]
Mailing List and IRC Channel
****************************
You can discuss this code on the `edx-code Google Group`__ or in the
``edx-code`` IRC channel on Freenode.
__ https://groups.google.com/g/edx-code
.. |build-status| image:: https://github.com/openedx/edx-notes-api/actions/workflows/ci.yml/badge.svg
:target: https://github.com/openedx/edx-notes-api/actions/workflows/ci.yml