manual IconInstallation
Database IconDatabases
Chart IconCharts
Filter IconFilter
Playbook IconPlaybook

On this Page

Prerequisites
Backend Installation and Setup
Frontend Installation and Setup
Additional Notes
v1.0DocumentationInstallation

Silzila Application Installation Guide for Github Contributors

Prerequisites

For Backend

  • Java Development Kit (JDK): Ensure you have JDK 17 or higher installed.
  • Maven: Ensure you have Maven installed and configured.
  • Git: Ensure you have Installed git before proceeding forward. Please, refer Git Installation Guide.
  • VS Code / IntelliJ IDEA: Any Java IDE for running the backend application.
  • API Testing Tool: Insomnia, Postman, or any other API testing tool.

For Frontend

  • Node.js and NPM: Ensure you have Node.js and NPM installed.
    • For Windows: Download and Install Node.js
    • For macOS: Install via Homebrew: brew install node

Backend Installation and Setup

Clone the Repository

  1. Create a folder called silzila (or any name of your choice).
  2. Open your command prompt (Windows) or terminal (macOS/Linux) and navigate to the folder:
    3. cd path/to/your/silzila/folder
    Copy Iconcopy
  3. Clone the Silzila repository:

    git clone Click here

Open and Run the Application

  1. Open the cloned repository in your IDE (e.g., VS Code / IntelliJ IDEA ).
  2. Navigate to the viz application within the IDE.
  3. Click the run symbol in vs code/ IntelliJ IDEA , to run the backend Spring boot code.

    vs-code


    IntelliJ-Viz


  4. Spring boot application will run in http://localhost:8080

API Testing

  1. Install Insomnia or any other API testing tool.
  2. Import the provided Insomnia API file into your API testing tool. This file contains all the necessary API endpoints for testing the Silzila application.
  3. Use the imported API endpoints to test the Silzila backend.

Frontend Installation and Setup

Navigate to the Folder

  1. Open your command prompt (Windows) or terminal (macOS/Linux).
  2. Navigate to the Silzila frontend folder:
    3. cd path/to/silzila/silzila-frontend
    Copy Iconcopy

Install Dependencies

  1. Install npm dependencies:
    2. npm install
    Copy Iconcopy
  2. If the installation fails, force install the dependencies:
    3. npm install -f
    Copy Iconcopy

Start the Frontend Application

  1. Once the dependencies are installed successfully, start the frontend application:
    2. npm start
    Copy Iconcopy
  2. React application will open in default browser in http://localhost:3000

Additional Notes

  • Ensure that both backend and frontend are running simultaneously to fully test the application.
  • If you face any issues during the installation or running process, refer to the respective official documentation for Java, Maven, Node.js, and NPM.

By following these steps, you should be able to set up and run both the backend and frontend of the Silzila application successfully.