Project README

Demo Video: https://youtu.be/jTz1iEvyECA

Presentation: https://drive.google.com/file/d/1g3s1aFOpoNX8NSsI2WZ7Wa56xWgRufpO/view?usp=sharing

This project is structured into three main folders: frontend, backend, and server. Each folder contains a different part of the application, and all three components need to be running simultaneously for the project to function correctly. Below are the instructions to set up and run each part of the project.

Project Structure

• frontend: Contains the frontend code for the project.
• backend: Contains the backend code for the project.
• server: Contains the Flask servers (both bigram_server.py and flask_server.py).

Prerequisites

Before running the project, ensure you have the following installed:

• Node.js and npm (for frontend and backend)
• Python and pip (for Flask servers)
• Conda (for managing Python environments)
• Git (for cloning repositories)

Setup Instructions

1. Frontend Setup

1. Navigate to the frontend folder:

   cd frontend

2. Install the required dependencies:

   npm install

3. Run the frontend development server:

   npm run dev

   The frontend should now be running on a local development server (usually http://localhost:3000).

2. Backend Setup

1. Navigate to the backend folder:

   cd backend

2. Install the required dependencies:

   npm install

3. Run the backend development server:

   npm run dev

   The backend should now be running on a local development server (usually http://localhost:5000).

3. Flask Server Setup

Cloning the MaleX Repository

1. Navigate to the server folder:

   cd server

2. Clone the MaleX repository:

   git clone https://github.com/Mayachitra-Inc/MaleX.git

Environment Setup On Linux

1. navigate to the yml directory with the environment config

   cd yml

2. Create and activate the Conda environment for the main server using the main.yml file in the root directory:

   conda env create -f main_linux.yml
   conda activate anaware_flask_server

3. Create and activate the Conda environment for the malex server using the malex.yml file in the root directory:

   conda env create -f malex_linux.yml
   conda activate anaware_bigram_server

Environment Setup On windows

1. navigate to the yml directory with the environment config

   cd yml

2. Create and activate the Conda environment for the main server using the main.yml file in the root directory:

   conda env create -f main_windows.yml
   conda activate anaware_flask_server

3. Create and activate the Conda environment for the malex server using the malex.yml file in the root directory:

   conda env create -f malex_windows.yml
   conda activate anaware_bigram_server

Running the Flask Servers

1. Running the main server (flask_server.py):

   • Ensure the main environment is activated.
   • Run the server:

     python flask_server.py

   • Note the port on which this server is running (e.g., http://localhost:5001).

2. Running the malex server (bigram_server.py):

   • Ensure the malex environment is activated.
   • Run the server:

     python bigram_server.py

   • Note the port on which this server is running (e.g., http://localhost:5002).

4. Configuring the Backend

1. Open the backend/index.ts file.
2. Locate line number 25 where the FLASK_ENDPOINT variable is defined.
3. Update the FLASK_ENDPOINT variable with the URL of the main server (e.g., http://localhost:5001).

5. Running the Project

1. Ensure all three servers (frontend, backend, and Flask servers) are running.
2. The frontend must run on http://localhost:5173.
3. The backend must run on http://localhost:8787.
4. The project should now be fully functional.

Troubleshooting

• Port Conflicts: If any of the servers fail to start due to port conflicts, ensure that the ports are free or update the port numbers in the respective server files.
• Environment Issues: If you encounter issues with the Conda environments, try recreating them using the provided .yml files.
• Dependency Issues: If npm install or pip install fails, ensure that you have the correct versions of Node.js, npm, Python, and pip installed.

Conclusion

Once all the components are set up and running, you should have a fully functional project with a frontend, backend, and Flask servers working together. If you encounter any issues, refer to the troubleshooting section or consult the documentation for the respective technologies used in this project.

Happy coding! 🚀