Skip to main content

Requirements 📜

Your machine should have Yarn or Npm installed.

Note: Preferable versions

node16
npm6
yarn1.16
turbo1.9.1
  • Check the node and npm version by running following commands.
node -v
npm -v
  • Install yarn globally
npm i yarn -g

Installation Steps 🚶‍♂️

1. Fork it 🍴

You can get your own fork/copy of Sunbird-UCI by using the Fork button.

2. Clone it 👥

You need to clone (download) it to a local machine using

git clone https://github.com/samagra-comms/uci-web-channel.git

This makes a local copy of the repository in your machine.

Once you have cloned the Sunbird-UCI repository in GitHub, move to that folder first using the change directory command.

This will change directory to a folder

cd uci-web-channel

Move to this folder for all other commands.

3. Set it up ⬆️

Run the following commands to see that your local copy has a reference to your forked remote repository in GitHub :octocat:

git remote -v

By running the above command, you can see that the local copy has a reference to the forked remote repository in GitHub.

origin  https://github.com/Your_Username/uci-web-channel.git (fetch)
origin  https://github.com/Your_Username/uci-web-channel.git (push)

4. Install and Build 💻

  • Install dependencies
yarn install
  • Build the code
yarn build

Browse - http://localhost:3003

5. Running the application 🏃‍♂️

  • Run application in dev environment
yarn run dev

This is implemented through NextJS and socket-package

Contents

Edit this page