Project Workflow

Workflow

1. First and foremost you need to install NodeJS in your system. Please use this link as a guide to setup NodeJs
   https://nodejs.org/en/docs/guides

2. Then Fork/Clone the repository ;

   $ git clone https://github.com/lokesh45/TeamFormationAssistant.git

3. Install virtual environment in your system by following the link: https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/

4. Create a virtual environment in the project folder and install the dependencies from the requirements.txt in your virtual environment.

   (venv) $ pip install -r src/requirements.txt

5. Open 2 more different terminals and navigate to the repository. Again, these terminals should not be closed as we need to keep the servers running.

6. Open NodeJS folder in terminal-1 and run the command "node server.js". This would setup the server for the application. Do not close the terminal until unless you want to close the application itself. The server runs at port 3001 on the localhost. Here is the link:http://localhost:3001

7. Run the python file to perform the assignment.

   (venv) $ python TeamAssigner.py

8. Now the next step is to run our client, for this in the home directory, using terminal-2 run the command "npm start". This would kick start your application and you will be navigated to the web page. The client runs at port 3000 on the localhost. Here is the link:http://localhost:3000

9. Once new data is submitted using the web page, the client code sends the input to the server. The server then requests the flask server to perform the Member to Team Mapping and persist the new data in the DataBase.

Note

If you face any errors in running the server or client don't worry that may be because of express version mismatch, Please run these commands in both home directory and NodeJS directory,

1. node uninstall express.

2. node install express.

3. node install

Running these 3 commands in both the locations, would help update the packages as per the requirement.