Deployment Steps

This section contains the deployment steps of VReqST tool.

Source Code

Please find the lastest VReqST tool from here - https://github.com/Amogha027/VReqST-2

Hardware Requirement

Client Machine (end user): A minimum of a Pentium 4 processor with at-least 128MB of RAM is needed, while 256MB is recommended for optimal performance. A minimum of 100MB of free disk space is necessary, with 200MB or more recommended for efficient operation. Ensure that you have enough storage capacity to accommodate your desired web browser and any associated files, such as bookmarks and cache. Any standard display should suffice, as long as it allows you to view web pages comfortably. Keyboard and mouse are essential for interacting with websites and inputting text. Touchpads or touchscreens can also serve this purpose. Additionally, a network connection is crucial for browsing the internet. This can include wired connections via Ethernet cables or wireless connections using Wi-Fi or cellular networks

Server Machine (VReqST Host Server): A multi-core processor with a high clock speed is ideal for handling heavy traffic and resource-intensive applications. Look for a processor with at least 8 cores and a frequency higher than 3 GHz. Ensure you have enough RAM to accommodate simultaneous user requests and prevent your website from slowing down or crashing. If your website receives a lot of traffic, consider a dedicated server with at least 16 or 32GB of RAM. Choose a storage option that fits your capacity and performance needs. While traditional hard disk drives (HDDs) are cheaper and offer a lot of storage space, they have relatively slow reading and writing speeds. Solid-state drives (SSDs) are faster and more expensive but provide better performance. 1 TB of ROM is recommended.

Software Requirement

Client Machine (end user): Any basic operating system, like Windows 10 or above, MacOS, or any Linux variant, is required on a client’s machine. A web browser to browse the VReqST application and its related documentation site. TCP/IP protocol suite to communicate with network and gain access to internet.

Server Machine (VReqST Host Server): In addition to the client machine software requirements, deploy git from https://git-scm.com to access VReqST source code from Github version control. Deploy Node.js version 14 from https://node.js.org and install it on the server machine.

Steps to Deploy

Following are the detailed steps to deploy VReqST tool on the server machine

  • Open git terminal and use the command and install

$ git clone https://github.com/Amogha027/VReqST-2

  • Now navigate to VReqST-2, VReqST-main and VReqST folder and run the following command on the terminal

$ cd VReqST-2/VReqST-main/VReqST

  • This will deploy the VReqST on the server machine

  • The backend server and validation server instances are already hosted on render . This will build and executes our project code into production dynamically

  • Alternatively, to host the application on hosted instance, update the environment URLs of validation server and backend in the following path of node.js application through command terminal - ‘frontend/client/src/server urls.jsx’ as follows

$ export const validation_server = "http://localhost:5001"
$ export const backend = "http://localhost:5002"

  • To start the backend server on port 5002, navigate to VReqST folder on command terminal and run following.

$ cd backend

  • To start validation server on Port 5001, navigate to VReqST folder on command terminal and run following

$ cd validation_server
$ npm install
$ nodemon index.js

  • To start the application on port 3000, navigate to VReqST folder on command terminal and run following

$ cd frontend
$ npm install
$ npm run client-install
$ npm run dev

  • Upon running the application, the VReqST will be launched on the default browser with a local site http://localhost:3000. You may allow the site access to intranet by providing a desired domainname and grant access to targeted user-group.

Configuring Database

Following are the detailed steps required to configure MongoDB database instance on-demand remotely.

  • Access https://mongodb.com and create an account. Create a new project and add a new database to the project

  • Define 4 collection with following naming convention - customrules, jsons, projects and users.

  • This will create a new dedicated isntance of the database that is required to be linked to your VReqST

  • You may access the collection data under databases listed on https://mongodb.com

PreviousStep 5 - Timeline

Last updated