Skip to main content

Appshare Development Environment

Welcome to the Appshare development environment. This guide will help you get started with setting up and managing your development server and applications.

Appshare apps are built using the React framework. If you are new to React, we recommend you to go through the official React documentation.

For UI we are using Material-UI, you can find the documentation here.

Setting up the Development Environment​

Requirements​

  • Node.js (LTS recommended)
  • Git
  • NPM (included with Node.js) — not yarn or pnpm

Note: Before proceeding, install Node.js on your system.

Once you have completed the setup, the first step is to clone the repository.

Clone the Repository​

git clone <repository-url>
cd <repository-name>

Once you are inside the repo, you need to create a .npmrc file before installing dependencies.

Create .npmrc File​

  1. Create a .npmrc file in the root of your project
  2. Get the .npmrc content by going to jde.appshare.app and navigating to administration → settings → developers → npmrc tab
  3. Copy and paste the content into the .npmrc file

Install Dependencies​

Once you have created the .npmrc file, install the dependencies:

npm install

Login Credentials​

Create an env.json file in the local/ directory with the following content:

{
  "server": "your-ais-server.com",
  "username": "your-username",
  "password": "your-password"
}
Warning

Replace the above credentials with your own AIS server URL, username, and password.

Creating a New App​

To create a new app, follow the steps here