CodeComments (Bachelor Thesis)

Running Project Locally

To run the project locally, you will need Docker and Docker Compose.

First, clone the repository:

git clone https://github.com/S1lence-z/code-comments-bachelor-thesis.git
cd code-comments-bachelor-thesis

Next, create a .env file in the root of the project with the following content (or just rename the file .env.example to .env):

# Port configuration
SERVER_PORT=5000
CLIENT_PORT=3000
MANAGER_PORT=3001

# Tokens
VITE_GITHUB_PAT=your_github_pat_here

# URLs
VITE_SERVER_URL=http://localhost/server
VITE_MANAGER_URL=http://localhost
VITE_CLIENT_URL=http://localhost/client
VITE_CLIENT_BASE_PATHNAME=/client

⚠️ Warning: Not providing the VITE_GITHUB_PAT variable gives you a very limited rate of requests to the GitHub API (50 requests per hour). To increase this limit to 5000 requests per hour, you can create a GitHub Personal Access Token and set it as the value of the VITE_GITHUB_PAT variable. If you do not want to create a token, you must leave the variable empty.

Finally, run the following commands to build and start the application:

docker compose build --no-cache
docker compose up

The applications will be available at the following URLs:

• Client: http://localhost/
• Server (Swagger UI): http://localhost/server/swagger/index.html

---

Bachelor Thesis Specification

The full specification for the thesis is available in the following document.

Overleaf

The thesis is written in LaTeX and managed on Overleaf.