@edx/frontend-lib-special-exams

##########################
frontend-lib-special-exams
##########################

*
Purpose
*
This is a react library responsible for extending learning app with special exams functionality, e.g. proctored/timed exams.

*
Getting Started
*

Installation
============

1. Clone your new repo:

`git clone https://github.com/edx/frontend-lib-special-exams.git

2. Use node v12.x.

Using other major versions of node may work, but is unsupported. For convenience, this repository includes an .nvmrc file to help in setting the correct node version via nvm _.

3. Install npm dependencies:

cd frontend-lib-special-exams && npm install

*
Build Process Notes
*

Production Build

The production build is created with npm run build.

*
Internationalization
*

Please see edx/frontend-platform's i18n module _ for documentation on internationalization. The documentation explains how to use it, and the How To _ has more detail.

*
Plugins
*

This MFE can be customized using Frontend Plugin Framework _.

The parts of this MFE that can be customized in that manner are documented here _.

**
Contributing
**

Contributions are very welcome. Please read How To Contribute_ for details.

.. _How To Contribute: https://openedx.org/r/how-to-contribute

This project is currently accepting all types of contributions, bug fixes,
security fixes, maintenance work, or new features. However, please make sure
to have a discussion about your new feature idea with the maintainers prior to
beginning development to maximize the chances of your change being accepted.
You can start a conversation by creating a new issue on this repo summarizing
your idea.

**
Getting Help
**

If you're having trouble, we have discussion forums at
https://discuss.openedx.org where you can connect with others in the community.

Our real-time conversations are on Slack. You can request a Slack
invitation_, then join our community Slack workspace_. Because this is a
frontend repository, the best place to discuss it would be in the #wg-frontend
channel_.

For anything non-trivial, the best path is to open an issue in this repository
with as many details about the issue you are facing as you can provide.

https://github.com/openedx/frontend-lib-special-exams/issues

For more information about these options, see the Getting Help_ page.

.. _Slack invitation: https://openedx.org/slack
.. _community Slack workspace: https://openedx.slack.com/
.. _#wg-frontend channel: https://openedx.slack.com/archives/C04BM6YC7A6
.. _Getting Help: https://openedx.org/community/connect

**
The Open edX Code of Conduct
**

All community members are expected to follow the Open edX Code of Conduct`_.

.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/

Reporting Security Issues

Please do not report security issues in public. Please email security@openedx.org.