diff --git a/README.rst b/README.rst index 7011656..ceb8fb6 100644 --- a/README.rst +++ b/README.rst @@ -3,44 +3,73 @@ frontend-app-account ==================== -This is a micro-frontend application responsible for the display and updating of a user's account information. Please tag **@edx/arch-team** on any PRs or issues. +Please tag **@sarina** on any PRs or issues. Thanks! -Development ------------ +Introduction +------------ -Start Devstack -^^^^^^^^^^^^^^ +This is a micro-frontend application responsible for the display and updating of a user's account information. -To use this application `devstack `__ must be running and you must be logged into it. +What is the domain of this MFE? -- Start devstack -- Log in (http://localhost:18000/login) +In this MFE: Private user settings UIs. Public facing profile is in a `separate MFE (Profile) `_ -Start the development server -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +- Account settings page -In this project, install requirements and start the development server by running: +- Demographics collection -.. code:: bash +- IDV (Identity Verification) - npm install - npm start # The server will run on port 1997 +Installation +------------ -Once the dev server is up visit http://localhost:1997. +This MFE is bundled with `Devstack `_, see the `Getting Started `_ section for setup instructions. -Configuration and Deployment ----------------------------- +1. Install Devstack using the `Getting Started `_ instructions. -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: +2. Start up Devstack, if it's not already started. + +3. Log in to Devstack (http://localhost:18000/login ) + +4. Within this project, install requirements and start the development server: + + .. code-block:: + + npm install + npm start # The server will run on port 1997 + +5. Once the dev server is up, visit http://localhost:1997 to access the MFE + + .. image:: ./docs/images/localhost_preview.png + +Environment Variables/Setup Notes +--------------------------------- + +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 `__. +Known Issues +------------ + +None + +Development Roadmap +------------------- + +We don't have anything planned for the core of the MFE (the account settings page) - this MFE is currently in maintenance mode. +There may be a replacement for IDV coming down the pipe, so that may be DEPRed. +In the future, it's possible that demographics could be modeled as a plugin rather than being hard-coded into this MFE. + + +============================== + .. |Build Status| image:: https://api.travis-ci.com/edx/frontend-app-account.svg?branch=master :target: https://travis-ci.com/edx/frontend-app-account .. |Codecov| image:: https://img.shields.io/codecov/c/github/edx/frontend-app-account diff --git a/docs/images/localhost_preview.png b/docs/images/localhost_preview.png new file mode 100644 index 0000000..0296e1a Binary files /dev/null and b/docs/images/localhost_preview.png differ