Usama Sadiq e91a8a4dfa Merge pull request #452 from edx/aht/bom-2901-switch-ci-to-github-actions
BOM-2901: Replace travis with github CI
2021-10-22 15:13:11 +05:00
2021-01-28 12:36:32 +05:00
2020-09-28 09:08:15 -04:00
2021-05-21 14:37:44 +05:00
2020-09-28 09:08:15 -04:00
2021-02-10 12:35:15 +05:00
2021-05-25 14:18:35 +05:00
2020-09-28 09:08:15 -04:00
2021-10-22 14:52:30 +05:00
2021-01-28 12:36:32 +05:00
2020-09-28 09:08:15 -04:00

|Build Status| |Codecov| |license|

frontend-app-authn
=================================

This is a micro-frontend application responsible for the login, registration and password reset functionality.

Development
-----------

Start Devstack
^^^^^^^^^^^^^^

To use this application `devstack <https://github.com/edx/devstack>`__ must be running.

-  Start devstack

Start the development server
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

In this project, install requirements and start the development server by running:

.. code:: bash

   npm install
   npm start # The server will run on port 1999

Once the dev server is up visit http://localhost:1999/login.

Configuration and Deployment
----------------------------

This MFE is configured via node environment variables supplied at build time. See the .env file for the list of required environment variables. Example build syntax with a single environment variable:

.. code:: bash

   NODE_ENV=development ACCESS_TOKEN_COOKIE_NAME='edx-jwt-cookie-header-payload' npm run build


For more information see the document: `Micro-frontend applications in Open
edX <https://github.com/edx/edx-developer-docs/blob/5191e800bf16cf42f25c58c58f983bdaf7f9305d/docs/micro-frontends-in-open-edx.rst>`__.

.. |Build Status| image:: https://api.travis-ci.com/edx/frontend-app-authn.svg?branch=master
   :target: https://travis-ci.com/edx/frontend-app-authn
.. |Codecov| image:: https://img.shields.io/codecov/c/github/edx/frontend-app-authn
   :target: https://codecov.io/gh/edx/frontend-app-authn
.. |license| image:: https://img.shields.io/npm/l/@edx/frontend-app-authn.svg
   :target: @edx/frontend-app-authn
Description
No description provided
Readme AGPL-3.0 24 MiB
Languages
JavaScript 79%
TypeScript 17.7%
SCSS 2.9%
Makefile 0.2%
HTML 0.2%