Table of Contents

1. Getting Started
   • Prerequisites
   • Cloning the Repository
   • Setting up the Backend
   • Setting up the Frontend
   • Accessing the Application
2. Setting up GitLab and Git in PyCharm
   • Cloning the Repository in PyCharm
   • Setting Up Git
   • Working with Git
   • Working with GitLab

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• Git
• Python (with pip)
• Node.js and npm
• PyCharm (or your preferred IDE)

Cloning the Repository

First, clone the repository to your local machine:

git clone https://gitlab.cci.drexel.edu/data-guardian/senior-project.git
cd senior-project

Setting up the Backend

1. Open the Backend in PyCharm:

   • Open PyCharm and select Open.
   • Navigate to the backend directory within the cloned repository and open it.

2. Configure Python Interpreter:

   • In PyCharm, go to File > Settings > Project: backend > Python Interpreter.
   • Create a new virtual environment or select an existing one.

3. Install Dependencies:

   • In PyCharm's terminal, run:

     pip install -r requirements.txt

4. Run Migrations:

   • In the terminal, execute:

     python manage.py migrate

5. Start the Django Development Server:

   • Run:

     python manage.py runserver

Setting up the Frontend

1. Open the Frontend in PyCharm in a New Window:

   • Use File > Open in a new window and select the frontend directory.

2. Install Node Modules:

   • In the terminal within PyCharm, run:

     npm install

   • Also run:

     npm install zxcvbn

3. Start the React Development Server:

   • Execute:

     npm start

Accessing the Application

• The backend API will be available at http://localhost:8000.
• The frontend will be available at http://localhost:3000.

Built With

• Django - The web framework used for the backend
• React - The web framework used for the frontend

Setting up GitLab and Git in PyCharm

To work with this project in PyCharm and synchronize it with the GitLab repository, follow these steps:

Cloning the Repository in PyCharm

1. Open PyCharm and Clone the Repository:
   • Go to File > New > Project from Version Control.
   • In the URL field, enter https://gitlab.cci.drexel.edu/data-guardian/senior-project.git.
   • Choose the directory where you want to clone the project and click Clone.

Setting Up Git

1. Check Git Configuration:
   • Go to File > Settings > Version Control > Git.
   • Ensure Git is correctly installed and configured.

Working with Git

1. Commit Changes:

   • Make changes to your files in the PyCharm editor.
   • Open the Commit tool window (Alt + 0).
   • Review your changes, stage them, write a commit message, and commit.

2. Pull and Push Changes:

   • To pull changes from GitLab, go to VCS > Git > Pull.
   • To push changes to GitLab, go to VCS > Git > Push.

Working with GitLab

1. Issue Tracking and Project Management:

   • Use GitLab's issue tracking and project management features to collaborate on tasks.
   • Access these features through your project's GitLab page.

2. Merge Requests:

   • Create merge requests in GitLab to propose and review changes.
   • Merge requests can be managed through the GitLab web interface.

Remember to regularly pull changes from the remote repository to keep your local project up to date and to reduce merge conflicts.