Open Source Project 2023 - InfiniThree Source Code - Using ReactJS as Frontend Side and Python Flask as Backend Side

Public client: https://infinithree.netlify.app/

Public server restful api: http://infinithree-law.site/

Slide powerpoint: https://www.canva.com/design/DAF2QBFyF_8/5aQUC_jwhsr-n47JDp0lOQ/edit

How to Install and Run the Project

Setting Up the ReactJS Project:

1. Clone the ReactJS project to your folder

git clone https://github.com/NganBao0206/codification_law_infiniThree.git

then move to the frontend folder

cd codification_law_infiniThree/frontend

2. Install project dependencies

npm install

3. Run the project

npm run dev

This will start the development server, and your React app will be available at http://localhost:5173 by default.

Setting up the Python Flask server

1. Clone the Python Flask project

git clone https://github.com/NganBao0206/codification_law_infiniThree.git

3. Open codification_law_infiniThree/backend/server folder.

4. Create a new file named .env.

5. Open the .env file and set your environment variables as follows:

   DB_USER=<your-database-username>
   DB_PASS=<your-database-password>
   DB_HOST=<your-database-host>
   DB_NAME=<your-database-name>
   HOST=localhost
   CORS_URL=http://localhost:5173
   JWT_SECRET_KEY=n3rfq83r18fhnc12rh19dic12ndcn3u9cuwecnjc2i3uhf981h12ufn1fo1u93fhi
   CLOUDINARY_CLOUD_NAME=dljmwib1r
   CLOUDINARY_API_KEY=551239148838771
   CLOUDINARY_API_SECRET=FCXYKNM3fQHa9ein5j-WJB90H0s
   

Running the Program in VSCode

1. Open VSCode.
2. Go to File -> Open Folder.
3. Navigate to and select the codification_law_infiniThree/server folder.
4. Press Ctrl+Shift+P to open the Command Palette.
5. Type and select Python:Create Environment.
6. In the terminal, activate the virtual environment using the command source .venv/bin/activate.
7. Install the required packages with pip install -r requirements.txt.
8. Run program with python run.py.

Running the Program in PyCharm

1. Open PyCharm.
2. Go to File -> Open....
3. Select the codification_law_infiniThree/server folder.
4. Go to File -> Setting -> Project: <Project-name> -> Python Interpreter.
5. Click on the plus (+) icon in the bottom right corner to add a new Python Interpreter.
6. Select Virtualenv Environment on the left.
7. Make sure New environment is selected and specify the path to the .venv directory in project folder in Location.
8. Select the Python version from the Base interpreter list.
9. Click OK to create the virtual environment.
10. Open the Terminal in PyCharm (View -> Tool Windows -> Terminal).
11. In the terminal, activate the virtual environment using the command source .venv/bin/activate.
12. Install the required packages with pip install -r requirements.txt.
13. Navigate to the run.py file in the PyCharm Project Tool Window.
14. Right-click on the run.py file and select Run 'run'.

Prepare Database

1. Create a new database in MySQL Server.
2. Update the .env file with your database information.
3. Run models.py to create table.

Installing Docker on Ubuntu

You will need the following:

• One Ubuntu server set up, including a sudo non-root user and a firewall.
• An account on Docker Hub if you wish to create your own images and push them to Docker Hub.

1. Update your existing list of packages: $ sudo apt update

2. Next, install a few prerequisite packages which let apt use packages over HTTPS: $ sudo apt install apt-transport-https ca-certificates curl software-properties-common

3. Then add the GPG key for the official Docker repository to your system: $ curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -

4. Add the Docker repository to APT sources: $ sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu focal stable"

5. Finally, install Docker: $ sudo apt install docker-ce

6. Docker should now be installed, the daemon started, and the process enabled to start on boot. Check that it’s running: $ sudo systemctl status docker

Installing PyTest

1. Prerequisites

• Python Installation.
• Pip Installation.

2. Open your terminal and run the command: pip install pytest

Installing Docker Compose on Ubuntu

1. By using the -o flag to specify the output file first rather than redirecting the output, this syntax avoids running into a permission denied error caused when using sudo.
2. Check the current release and if necessary, update it in the command below:

$ sudo curl -L https://github.com/docker/compose/releases/download/1.29.2/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose

3. Next set the permissions:

$ sudo chmod +x /usr/local/bin/docker-compose

4. Then you’ll verify that the installation was successful by checking the version:

  $ docker-compose --version

5. This will print out the version you installed:

Output
docker-compose version 1.29.2, build 5becea4c

Running with Docker-compose

1. Open the terminal.
2. Navigate to folder where codification_law_infiniThree is located by typing cd path/to/folder/codification_law_infiniThree.
3. Start the Docker containers by typing docker-compose up -d

Features included in the project

• Register / Login: Includes new user registration and login functionality, information authentication, database storage, and access authorization via tokens.
• Searching codification tree
• Look up legal terms: query terms and return pagination results based on keywords and page numbers.
• Discussion forum
• Chat bot: Currently, this feature only runs locally due to deployment difficulties as the server only has 2GB of RAM.
• Contact: provides a JWT-protected API endpoint for sending reports via email. It uses Flask and JWT to authenticate users and send email reports with the content and subject provided from the request.

Dependencies and libraries

Python (3.11.4)

1. Flask and related extensions:

• Flask (3.0.0)
• Flask-Bcrypt (1.0.1)
• Flask-Cors (4.0.0)
• Flask-JWT-Extended (4.5.3)
• Flask-SQLAlchemy (3.1.1)

2. Libraries that support data processing and calculations:

• NumPy (1.26.2)
• Pandas (2.1.3)
• SciPy (1.11.4)
• Scikit-learn (1.3.2)
• sklearn-crfsuite (0.3.6)

3. Libraries that support authentication, encryption, and security:

• PyJWT (2.8.0)
• Bcrypt (4.1.1)
• Werkzeug (3.0.1)

4. Other supporting libraries:

• Cloudinary (1.36.0)
• Jinja2 (3.1.2)
• MarkupSafe (2.1.3)
• SQLAlchemy (2.0.23)
• Tabulate (0.9.0)
• Jenkins LTS (2.426.1)
• Docker (24.0.7)
• Docker-compose (1.29.2)

System Organizing

CI / CD

API Docs

1. /api/codification-topics/

• Method: GET.
• Description: This endpoint returns all topics about the encryption.
• Return result: List of topics about encoding is returned as JSON.

2. /api/codification-topics/<topic_id>/sub-topics/

• Method: GET.
• Parameters: topic_id - ID of the topic to get information about child topics.
• Description: This endpoint returns all child themes of a specific theme.
• Returned result: List of child topics of the topic with corresponding IDs returned as JSON.

3. /questions

• Method: GET.
• Description: Retrieves a list of questions with optional keyword-based search and pagination.
• Parameters:
  • kw (string, optional): Keyword for searching questions.
  • page (integer, optional): Page number for pagination (default is 1).
• Returned Result: Returns a JSON object containing the total number of pages, total questions, and a list of questions matching the search criteria.

4. /questions

• Method: POST.
• Description: Adds a new question.
• Parameters: Form data containing:
  • title (string): Title of the question.
  • description (string): Description of the question.
  • user_id (string): ID of the user posting the question.
  • topic_id (string): ID of the topic associated with the question.
• Returned Result:
  • If successful, returns a JSON response indicating success: {"msg": "Post Question success"} with status code 201.
  • If there's an error, returns a JSON response with an error message: {"msg": "Error message"} with status code 400.

5. questions/topic/<topic_id>

• Method: GET.
• Description: Retrieves all questions related to a specific topic.
• Parameters: <topic_id> (string) - ID of the topic to fetch related questions.
• Returned Result: Returns a JSON list containing the questions associated with the provided topic ID.

6. /questions/user/<user_id>

• Method: GET.
• Description: Retrieves all questions posted by a specific user.
• Parameters: <user_id> (string) - ID of the user to fetch related questions.
• Returned Result: Returns a JSON list containing the questions associated with the provided user ID.

7. /api/codification-indexes/<indexes_id>/children/

• Method: GET.
• Description: This endpoint retrieves all child indexes of a specific index.
• Parameters: <indexes_id> (string) - ID of the index to fetch child indexes information.
• Returned Result: Returns a JSON list of child indexes belonging to the corresponding index.

8. /api/codification-sub-topics/<sub_topic_id>/indexes/

• Method: GET.
• Description: Retrieves all indexes related to a specific sub-topic.
• Parameters: <sub_topic_id> (string) - ID of the sub-topic to fetch related indexes.
• Returned Result: Returns a JSON list containing the indexes associated with the provided sub-topic.

9. /api/codification-sub-topics/<sub_topic_id>/legal-documents/

• Method: GET.
• Description: Retrieves all legal documents related to a specific sub-topic.
• Parameters: <sub_topic_id> (string) - ID of the sub-topic to fetch related legal documents.
• Returned Result: Returns a JSON list containing the legal documents associated with the provided sub-topic.

10. /replies

• Method: POST.
• Description: Adds a reply to a question.
• Parameters: Form data containing:
  • content (string): Content of the reply.
  • user_id (string): ID of the user posting the reply.
  • question_id (string): ID of the question the reply is posted to.
• Returned Result:
  • If successful, returns a JSON response indicating success: {"msg": "Post Question success"} with status code 201.
  • If there's an error, returns a JSON response with an error message: {"msg": "Error message"} with status code 400.

11. /replies/question?question_id=<question_id>

• Method: GET.
• Description: Retrieves all replies related to a specific question.
• Parameters: question_id (string) - ID of the question to fetch related replies.
• Returned Result: Returns a JSON list containing the replies associated with the provided question ID.

12. /replies/user?user_id=<user_id>

• Method: GET.
• Description: Retrieves all replies posted by a specific user.
• Parameters: user_id (string) - ID of the user to fetch related replies.
• Returned Result: Returns a JSON list containing the replies associated with the provided user ID.

13. /terminology

• Method: GET.
• Description: Retrieves a list of terminologies with optional keyword-based search and pagination.
• Parameters:
  • kw (string, optional): Keyword for searching terminologies.
  • page (integer, optional): Page number for pagination (default is 1).
• Returned Result: Returns a JSON object containing the total number of pages, total terminologies, and a list of terminologies matching the search criteria.

14. /terminology/search-paragraph

• Method: POST.
• Description: Searches for terminologies in a provided paragraph.
• Parameters: JSON data containing:
  • paragraph (string): Paragraph to search for terminologies.
• Returned Result: Returns a JSON array containing the found terminologies from the provided paragraph.

15. /user/register

• Method: POST.
• Description: Registers a new user with provided details including username, email, name, password, and an optional avatar.
• Parameters:
  • username (string): User's username.
  • email (string): User's email.
  • name (string): User's name.
  • password (string): User's password.
  • avatar (file, optional): User's avatar image file.
• Returned Result: Returns a message indicating the success or failure of user registration.

16. /user/login

• Method: POST.
• Description: Authenticates user credentials (username and password) for login purposes.
• Parameters:
  • username (string): User's username.
  • password (string): User's password.
• Returned Result: Returns an access token and user details upon successful authentication.

17. /user/username-existed

• Method: GET.
• Description: Checks if a username already exists.
• Parameters: username (string): User's username to check.
• Returned Result: Returns a message indicating whether the username exists or not.

18. /user/email-existed

• Method: GET.
• Description: Checks if an email already exists.
• Parameters: email (string): User's email to check.
• Returned Result: Returns a message indicating whether the email exists or not.

19. /api/chat-bot/

• Method: POST.
• Parameters:
  • msg (string): The message content sent to the chatbot.
  • sub_topic_id (string): ID of the sub-topic.
  • room_id (string, optional): ID of the chat room. If not provided, a new room will be created.
• Description: This endpoint sends a message to the chatbot for processing and retrieves a response based on the message content. It interacts with the chatbot model to generate a response relevant to the provided message and topic.
• Returned Result: Upon successful interaction and retrieval of a response from the chatbot, the endpoint returns the chatbot's message in JSON format, including detailed information about the response message.

Authors

1. Nguyen Kim Bao Ngan (2051052087ngan@ou.edu.vn)
2. Vo Phu Phat (2051052097phat@ou.edu.vn)
3. Tran Le Lan (2151050223lan@ou.edu.vn)