diff --git a/pages/developer-docs/configuring_sunbird/env_variables_temp.md b/pages/developer-docs/configuring_sunbird/env_variables_temp.md index 9053222dc..0a641564c 100644 --- a/pages/developer-docs/configuring_sunbird/env_variables_temp.md +++ b/pages/developer-docs/configuring_sunbird/env_variables_temp.md @@ -8,13 +8,11 @@ published: true allowSearch: false --- -## Overview +On installation, users can explore and work with Sunbird. The installation process takes care of the default minimum configuration required to run Sunbird. However, if you want to customize your instance of Sunbird, it is simple. For example, you can change the default logo to the logo of your choice, or change the default email address to your preferred email address. -On installation, users can explore and work with Sunbird. The installation process takes care of the default minimum configuration required to run Sunbird. However, if you want to customize your instance of Sunbird, it is simple. -Modify default behaviour or the look and feel by overriding the default values of environment variables as mentioned in the following table. -For example, you can change the default logo to the logo of your choice, or change the default email address to your preferred email address. +Modify default behaviour, look and feel by overriding the default values of environment variables as mentioned in the following tables. -**Note:** If you have not installed Sunbird, refer to [Server Installation](\pages\developer-docs\installation\server_installation) +**Note:** If you have not installed Sunbird yet, refer to [Server Installation](\pages\developer-docs\installation\server_installation){:target="_blank"} diff --git a/pages/developer-docs/configuring_sunbird/index.md b/pages/developer-docs/configuring_sunbird/index.md index 2e2503b8c..f3ffbacb8 100644 --- a/pages/developer-docs/configuring_sunbird/index.md +++ b/pages/developer-docs/configuring_sunbird/index.md @@ -8,10 +8,9 @@ published: true allowSearch: true keywords: Configure, configuration, env, environment variables, variables --- -## Overview The goal of the configuration section is to provide a simple, but flexible, way for anyone to get an instance of Sunbird up and running that is fully configured and ready-to-go. Before getting started, please look at the Sunbird [Installation options](pages\developer-docs\installation), to see which method for deploying Sunbird is right for you. -Refer to the Installation pages, for detailed installation instructions \ No newline at end of file +Refer to the Installation pages, for detailed installation instructions diff --git a/pages/developer-docs/installation/developer_installation.md b/pages/developer-docs/installation/developer_installation.md index 74c0459b4..27dd400f2 100644 --- a/pages/developer-docs/installation/developer_installation.md +++ b/pages/developer-docs/installation/developer_installation.md @@ -24,7 +24,7 @@ To install Sunbird, your laptop/PC should have at least the following minimum sy Installing Sunbird requires two primary software components: - Sunbird portal or web application -- Sunbird services stack or the backend API interface. +- Sunbird services stack or the backend API interface ## Sunbird Portal Setup @@ -43,6 +43,7 @@ Ensure that you meet the following prerequisites before installing and running t 1. **Software dependencies** * [Node](https://nodejs.org/en/download/){:target="_blank"} - install the latest release of 8.11.2 LTS series + * [nodemon](https://www.npmjs.com/package/nodemon){:target="_blank"} - install nodemon 2. **API Keys** @@ -60,7 +61,7 @@ The code can be cloned to your repository using the following command: ***Note***: Stable versions of the sunbird portal are available via tags for each release, and the master branch contains latest stable release. For latest stable release [refer](https://github.com/project-sunbird/sunbird-portal/){:target="_blank"} -Once the **git clone** command executes, proceed with running the following set of commands in the console: +Once the **git clone** command is executed, proceed with running the following set of commands in the console:
$ cd {PROJECT-FOLDER}/src/app @@ -69,7 +70,7 @@ Once the **git clone** command executes, proceed with running the following set $ npm install-***Note***: Please ensure that you are using node version 8.11.2 or above. Also, when prompted to set the environment variable please set the following +***Note***: Please ensure that you are using node version 8.11.2 or above. Also, when prompted to set the environment variable please set the following:
sunbird_environment=local @@ -146,5 +147,6 @@ Open a new terminal window $ cd {PROJECT-FOLDER}/src/app/client $ nodemon-After the commands get executed, open `http://localhost:3000` in the browser. + +Open `http://localhost:3000` in the browser.