Getting Started
Follow the steps below to get the project up and running.
Prerequisites
Node.js (Version: >=20.x)
MongoDB
NPM
Development
Setup
1.Clone the Repository
https://github.com/sjinnovation/CollaborativeAI.git
2. Navigate to the Client Folder
cd client
3. Install Dependencies
npm install
4. Navigate to the Server Folder
cd ../server
5. Install Backend Dependencies
npm install
6. Start Both Backend & Frontend Server
npm start
Development
Setup
1.Clone the Repository
https://github.com/sjinnovation/CollaborativeAI.git
2. Navigate to the Client Folder
cd client
3. Install Dependencies
npm install
4. Navigate to the Server Folder
cd ../server
5. Install Backend Dependencies
npm install
6. Start Both Backend & Frontend Server
npm start
Development
To initialize the application data and create a superadmin user, you can use either cURL or Postman:
If you prefer command-line tools, you can use curl to make a POST request to the /init-setup endpoint. Open your terminal and run the following command:
curl -X POST http://localhost:8011/api/init -H “Content-Type: application/json” -d ‘{
“fname”: “Super”,
“lname”: “Admin”,
“email”: “superadmin@example.com”,
“password”: “yourSecurePassword”,
“employeeCount”: 100,
“companyName”: “INIT_COMPANY”
}’
Initializing Setup with Postman
Open Postman:
Launch the Postman application.
Create a New Request:
Click on the ‘+’ or ‘New’ button to create a new request.
Set HTTP Method to POST:
Ensure that the HTTP method is set to POST.
Enter URL: Enter the URL http://localhost:8011/api/init.
Set Headers:
• Go to the ‘Headers’ tab.
• Set Content-Type to application/json.
Set Request Body:
• Switch to the ‘Body’ tab.
• Select the ‘raw’ radio button.
• Enter the JSON data for your superadmin user:
{
“fname”: “Super”,
“lname”: “Admin”,
“email”: “superadmin@example.com”,
“password”: “securePassword”,
“employeeCount”: 100,
“companyName”: “INIT_COMPANY”
}
Send Request: Click the ‘Send’ button to make the request.
This will send a POST request to http://localhost:8011/api/init with the provided JSON payload, creating a superadmin user with the specified details.
Site Setup: Login with the superadmin credentials and set up your site by adding configs from your settings page, for ex. API keys, etc.
