Skip to content

Latest commit

 

History

History
92 lines (56 loc) · 3.53 KB

SET_UP_DEV_ENVIRONMENT.md

File metadata and controls

92 lines (56 loc) · 3.53 KB
Raw

Setting Up Development Environment

Follow this guide to set up the source code, development tools & other software.

Prerequisite Software

To build and write code, make sure you have the following set of tools on your local environment:

  • Git - Open source distributed version control system. For install instructions, refer this.
  • Node.js - JavaScript runtime with node package manager (npm).
  • pnpm - Alternate npm client for faster package installs.
  • Maven - Build automation tool for Java projects.
  • Java Development Kit 1.8 - Development environment for building applications using the Java programming language.

Setting up Development Tools

NX Console

Editor plugin which wraps NX commands so you don't have to memorize.

React Developer Tools

Browser extension to debug React code.

Redux DevTools

Redux DevTools for debugging application's Redux store operations.

ESLint IDE Plugin

ESLint is a static code analysis tool for identifying problematic patterns found in JavaScript/Typescript code.

Make sure you setup the supplementary plugins in your IDE of choice.

Webstorm

WebStorm shows warnings and errors reported by ESLint right in the editor, as you type.

VS Code

Integrates ESLint into VS Code. The extension uses the ESLint library installed in the opened workspace folder.

Code Spell Checker

A basic spell checker that works well with code and documents.

JSON Sort Order

Sorts JSON objects in alphabetical order.

Setting up the Source Code

  1. Fork the repository.
  2. Clone your fork to the local machine.

Replace <github username> with your own username.

git clone https://github.com/<github username>/identity-apps.git
  1. Set the original repo as the upstream remote.
git remote add upstream https://github.com/wso2/identity-apps.git