Skip to content

Latest commit

 

History

History
86 lines (55 loc) · 2.53 KB

README.md

File metadata and controls

86 lines (55 loc) · 2.53 KB
Raw

UI Readme

The frontend is built using React and Redux. The backend is built using Django and Django Rest Framework. It uses nodejs and npm for package management. Make sure you have the right version of nodejs installed. You can check the version by running node -v in your terminal. The version should be v18.2.0. If you don't have the right version installed, you can install it here.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

you can use nvm to install the right version of nodejs. You used the command below to install nvm.

nvm install 18.2.0

then

nvm use 18.2.0

you can run the command below to start the frontend server.

npm start
  • formating you should automatically be able to format the code based on typescript requirements if not you can run this command on the fill
npx prettier --write SignIn.tsx

Running the tests

You can run the command below to run the tests

npm test

Installing the application as a root user

Note: we are using an ash shell therefore you can log in to the root user once you have logged into the container by using

su -

Running in debug mode

There is a launch.json file inside the .vscode folder. There are Debug UI and Debug Typescript(UI) pre-defined options that run the frontend in debug mode. you can launch one of the options, put breakpoints in the code and step through the code line by line.

package related issues

If you have package-related issues, you can first see what package is causing the problem. Using

npmvet -r inlinetable
npm outdate

update/install a package

  1. uninstall using npm uninstall <packagename>
  2. remove the npm-shrinkwrap file rm npm-shrinkwrap
  3. modify the package.json to the specific package version or install the new package
  4. using npm i or npm i <packagename> depending upon step 3 specific
  5. finally use the npm shrinkwrap --include=dev to create the npm-shrinkwrap.json file again

Fix npm issues

  1. npm cache clean --force
  2. rm -rf node_modules
  3. rm package-lock.json or rm npm-shrinkwrap.json depending on what you have locally
  4. npm install

Break down into end-to-end tests

You can have the backend running and run the command below to run the end-to-end tests.