Skip to content

Latest commit

 

History

History
71 lines (45 loc) · 2.72 KB

README.md

File metadata and controls

71 lines (45 loc) · 2.72 KB
Raw

Aditya-L1 Science Support Cell: Client-side

This is a React.js application for the client side (or front-end) of the Aditya-L1 Science Support Cell (website).

Local Setup

Pre-requisites

  • LINUX or MacOS Operating System

  • Install Git

  • Install and activate LTS version of Node.js

    It's recommended to use NVM to manage multiple active Node.js versions.

    • Install NVM using these instructions.

    • After that install latest LTS version of Node.js using:

      nvm ls-remote
nvm install --lts

      Note: This project was developed using v14 (fermium), so if you face any problems replace lts/* in above command with lts/fermium

    • The above command will also automatically activate the installed Node.js version in your shell. Now to make sure it gets activated each time you spawn a shell, do:

      nvm alias default `node -v`

      Note: If you don't want to use the installed Node.js version as default, you can replace default in above command with another alias name (say al1ssc). But then it's your responsibility to remember to activate this version when working with this project each time you spawn a shell, by doing nvm use al1ssc.

  • Install yarn (package manager for Node.js) globally:

    npm install -g yarn

Setting up project

  1. Clone the repository to your machine:

    git clone https://github.com/aries-res/al1ssc-client.git
cd al1ssc-client

  2. Install all dependencies of the project:

    yarn

  3. Run the React.js app in development mode:

    yarn start

    This will open http://localhost:3000 in your browser and any changes you'll make in code will automatically reflect in the webpage.

    Optional: If you want to configure additional settings like which port is used by development server, you can define concerned environment variables in an env.local file.

Additional information

You can find information about creating production build, analysing bundle size, etc. in Create React App docs.