Annotation Platform

Review Platform is an interactive and intuitive system that allows reviewers to log in and examine sentences to identify and label the presence of biases. Reviewers can assess various forms of bias, such as gender bias, racial bias, and hate speech, using a straightforward and efficient interface.

Table of Contents

• Installation
  • Prerequisites
  • Setup
• Usage
• Contributing
• License
• Contact

Installation

This project is built with Strapi. Follow these instructions to set it up locally and use the same data.

Prerequisites

Before starting, ensure you have Docker and Git installed on your system.

Setup

1. Clone the repository:

   git clone https://github.com/ngi-indi/module-annotation.git
   cd module-annotation

2. Build the Review Frontend Docker image:

docker build -t reviewfrontend .

3. Run the Review Frontend container:

docker run -d --name reviewfrontend --network indi_network -p 3000:3000 reviewfrontend

4. Build the MySQL Docker image:

cd ../db
docker build -t reviewdb .

5. Run the Review Database container:

docker run -d --name reviewdb --network indi_network -p 3306:3306 reviewdb

6. Build the Review Backend Docker image:

cd ../backend
docker build -t reviewbackend .

7. Run the Review Backend container:

docker run -d --name reviewbackend --network indi_network -p 1337:1337 reviewbackend

8. Access the Strapi admin panel:

   Open http://localhost:1337/admin.

9. Access the Frontend interface:

   Open http://localhost:3000.

Usage

Backend admin credentials:

• Username: [email protected]
• Password: 123456Ab

Frontend credentials:

• Administrator:

  • Username: [email protected]
  • Password: 123456

• Reviewer:

  • Username: [email protected]
  • Password: 123456

Contributing

Reporting bugs and requesting features

• If you find a bug, please open an issue.
• To request a feature, feel free to open an issue as well.

Developing a new feature

1. Fork the repository by clicking the "Fork" button at the top right of this page.
2. Clone your fork locally:

   git clone https://github.com/ngi-indi/module-bias-manager.git

3. Create a new branch for your feature or bug fix:

   git checkout -b feature-branch

4. Make your changes. Please follow the existing code style and conventions.
5. Commit your changes with a descriptive commit message:

   git commit -m "Add new feature: explanation of bias model predictions"

6. Push to your fork:

   git push origin feature-branch

7. Open a pull request from your fork’s branch to the main branch of this repository.

• Describe the changes you’ve made in the PR description.
• Ensure that your PR references any relevant issues.

License

This project is licensed under the GNU General Public License v3.0 License - see the LICENSE file for details.

Contact

For any questions or support, please reach out to:

• University of Cagliari: [email protected], [email protected], [email protected], [email protected]
• R2M Solution: [email protected]
• Website: Coming soon!