To contribute to this project, follow the steps below to set up the project on your local machine:
- Go to the RE-DACT GitHub repository and click the "Fork" button in the top-right corner.
- This will create a copy of the repository under your GitHub account.
-
Open a terminal on your local machine.
-
Run the following command to clone your forked repository:
git clone https://github.com/<your-username>/RE-DACT.git
Replace
<your-username>
with your GitHub username. -
Navigate to the project directory:
cd RE-DACT
To manage project dependencies, create a virtual environment:
-
Ensure you have Python 3 installed. You can check your Python version by running:
python3 --version
-
Create a virtual environment by running:
python3 -m venv env
Or if
python3
doesn't work, you can try:python -m venv env
-
Activate the virtual environment:
-
On Windows:
.\env\Scripts\activate
-
On macOS/Linux:
source env/bin/activate
If the activation command doesn't work on Windows, you might need to change the execution policy:
-
Run PowerShell as an administrator or your IDE shell.
-
Execute the following command:
Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
-
Press the key for "Yes to All" and then rerun the
.env\Scripts\activate
command in your VS Code terminal.
-
Once the virtual environment is activated, install the necessary dependencies:
pip install -r requirements.txt
To run the application locally, use the following command:
flask run
And then open localhost:5000 on your web browser.