A tool to demonstrate the multi-label classification of requirements artifacts, and its application.
The project consist of two main parts, a backend and a frontend. In order to start development you need to bring up the backend and the frontend.
Ensure that you have python v 3.9 installed on your machine.
- Navigate to the
./backend/folder using the terminal. - Create an copy of the environment file by running
cp .env.example .env. - Install backend dependencies by running the command
pip install -r requirements.txt. You should run this command evertime you pull the code from the repository and whenever you change the requirements file. - Start the server
python server.py.
Ensure that you have at least npm v 10.3.0.
- Navigate to the
./frontend/folder using the terminal. - Create an copy of the environment file by running
cp .env.example .env. - Install frontend dependencies by running the command
npm install. - Start the frontend development server by running
npm start.
The Docker images provided with this repository are not tested, but rather a WIP. Please refer to how to develop until the docker images are finalized.
The docker-compose.yaml contains the build argument REACT_APP_SERVER_URL to tell the compiled frontend where the backend's API can be reached.
You have to set this arugment before you build and run the Docker container.
Use docker compose up to build and run the containerized version of the backend and frontend.
Copyright © 2024 Waleed Abdeen
This work (source code) is licensed under GPLv3.