Vaahshare

Environment Setup

System Requirements

  • Minimum 4GB RAM
  • 50-100 MB of free disk space
  • Currently, the app works only on windows platform.

Software Dependencies

  • Common software dependencies required to run the app are:
    • Node.js
    • NPM
  • VaaShare:
    • Electron
    • Vue.js
    • Vite
  • Vaah Sockets:
    • Socket.io
    • Fastify
    • FFmpeg
    • Fluent-FFmpeg
  • Vaah Backend:
    • VaahCMS
    • PHP 8.0

Installation Steps

Step 1. Clone the repositories

  • VaahShare
git clone https://github.com/webreinvent/vaahshare.git
  • Vaah Sockets
git clone https://github.com/webreinvent/vaah-sockets.git
  • Vaah Backend
git clone https://github.com/webreinvent/vaah-backend.git

Installing VaahShare

  • Open the VaahShare project and install the dependencies
npm install
  • Copy the .env.test file to .env and update the environment variables as follows:
KeyDescriptionValue
VITE_APP_ENVVaahShare App Environmentdevelopment/production
VITE_API_URLVaahShare API URL or Backend URLhttp://localhost/himanshu/vaahshare-backend/public/api/
  • Run the app
npm run dev

Building VaahShare

  • To build the app, run the following command
npm run build
  • The app will be built and the output will be in the dist folder.
  • The dist folder contains executable file for windows platform and unpacked folder as well.

Installing Vaah Sockets

  • Open the Vaah Sockets project and install the dependencies
npm install
  • Copy the .env.test file to .env and update the environment variables as follows:
KeyDescriptionValue
PORTPort for the socket server3000
VITE_API_URLVaahShare API URL or Backend URLhttp://localhost/himanshu/vaahshare-backend/public/api/
  • Run the app
npm run start

Installing Vaah Backend

The backend is uses vaahcms. Please follow the setup guide for vaahcms to setup the backend.

  • After setting up the backend, navigate to the vaahcms > Modules > VaahShare and activate the module.
  • The backend is now ready to use.

Copyright © 2024