HIVE is a Node.js project built using Express and MongoDB. It serves as a platform for teams to collaborate, communicate, and manage their projects efficiently.
- User authentication and authorization
- Create, join, and manage teams
- Chat functionality for real-time communication
- Integration with machine learning and text analysis features
- Node.js
- Express.js
- MongoDB
- Socket.IO
- JWT (JSON Web Tokens) for authentication
- Mongoose for MongoDB object modeling
- Clone the repository:
git clone https://github.com/Group-task-brl/BRL-task4-backend.git- Navigate to the project directory:
cd BRL-task4-backend- Install dependencies:
npm install- Set up environment variables by creating a
.envfile and adding the necessary variables. You'll need:
PORT: Port number on which the server will run.MONGODB_URL: URL for your MongoDB database.EMAIL: Email address for sending notifications.PASSWORD: Password for the email account.- Other necessary environment variables (refer to the example in the README).
- Start the server:
npm start- Register or login to the application.
- Create or join a team.
- Utilize the chat feature for real-time communication.
- Explore other functionalities such as machine learning data analysis and text processing.
Make sure to set the required environment variables in your .env file. Here's an example of what your .env file might look like:
PORT=4000
MONGODB_URL='mongodb://127.0.0.1:27017/grouptaskdb'
EMAIL='[email protected]'
PASSWORD='your-email-password'
URL=http://localhost:4000
SECRET_KEY_JWT=your-secret-key-for-JWT
SECRET_KEY_SESSION=your-secret-key-for-session
TOKEN_HEADER_KEY=your-token-header-key
SECRET_KEY=your-secret-key
SITE_KEY=your-site-key
CLOUD_NAME=your-cloud-name
API_KEY=your-api-key
API_SECRET=your-api-secret
Make sure to replace the placeholder values with your actual environment variable values. This example provides a starting point for configuring your environment variables.
This section explains what environment variables are needed and provides an example `.env` file that users can reference when setting up their own environment.