Teamwise-Backend Installation
Follow these steps to install and run the TeamWise Node.js API on your local system. This guide assumes you have downloaded the full TeamWise bundle from CodeCanyon.
Step 1: Download and Extract
After purchasing TeamWise, download the ZIP file from CodeCanyon.
Extract the ZIP; you will
find the teamwise-backend folder. separately and in a specific order.
- unzip teamwise-backend.zip
- cd teamwise-backend
This folder contains all the backend files required to run the API, including source code, package.json, and sample .env configuration.
Step 2: Database Setup
TeamWise uses MySQL for storing users, teams, chat messages, and call logs.
Open your terminal and login to MySQL:
- mysql -u root -p
Create the Database:
- CREATE DATABASE teamwise;
Exit MySQL:
- EXIT;
Ensure that the database name matches the value in your .env file. You can use XAMPP/MAMP/LAMP or any MySQL server installed locally.
Step 3: Environment Configuration
Create a .env file in the root of the teamwise-backend folder. This file stores all environment-specific configuration.
- PORT=3000
- APP_DEMO_MODE=false
- DB_HOST=localhost
- DB_USER=root
- DB_DIALECT=root
- DB_PASSWORD=your_mysql_password
- DB_NAME=teamwise
- ADMIN_NAME=teamwise
- ADMIN_EMAIL=teamwise
- ADMIN_PASSWORD=teamwise
- SMTP_HOST=smtp.gmail.com
- SMTP_PORT=2525
- SMTP_USER=your_email@gmail.com
- SMTP_PASS=your_smtp_password
- JWT_SECRET=your_secret_jwt_key
Explanation of Key Variables :
-
PORT: The port on which the API will run (default 3000).
-
APP_DEMO_MODE: Enable true to activate demo restrictions and disable full functionality. When enabled, OTP is static (123456) and emails will not be sent.
-
DB_*: MySQL connection details. Ensure credentials match your database setup.
-
ADMIN_*: Default super admin user credentials. Can be changed after installation.
-
SMTP_*: Email configuration for sending notifications.
-
JWT_SECRET: Secret key for authentication tokens.
The .env file can be modified as per your local or server environment.
Step 4: Install Dependencies
Install all Node.js dependencies required to run the API:
- npm install
This installs core dependencies such as Express, Sequelize, Socket.IO, WebRTC packages, and other required libraries. React and frontend dependencies are not required here.
Step 5: Install Development Tools
For development purposes, it is recommended to install nodemon globally.
- npm install -g nodemon
Nodemon automatically restarts the server when file changes are detected.
Optional: install additional development dependencies if needed:
- npm install --save-dev
Step 6: Start the API
For development (auto-restart on changes):
- nodemon index.js
For production:
- node index.js
The backend API will start at http://localhost:3000 (or the port specified in .env).
Note : he full TeamWise backend bundle is included in the CodeCanyon purchase ZIP.
-- All required Node.js packages (including Socket.IO client and WebRTC libraries) are installed via npm install. No external installation is required.
-- Ensure MySQL is running via XAMPP/MAMP/LAMP or any local server before starting the API.
What's Next?
Let’s get started — your team’s new home is Teamwise Chat!
