DevGuard Setup Guide
DevGuard Overview
DevGuard is divided into two projects:
- Frontend: DevGuard Web, built with Next.js and React.js.
- Backend: DevGuard Backend, built with Go.
Required Services and Tools
To set up and run DevGuard, ensure the following services are installed on your machine:
- Git: For cloning and managing repositories.
- Docker: To run services in containers.
- Docker Compose: For orchestrating multi-container Docker applications.
- (DataGrip): For managing the database (or use any other database management tool of your choice).
- Go: Required to run the backend.
- Node.js: Required to run the frontend.
- Make: To execute commands in the Makefile.
- (Visual Studio Code (VS Code)): For managing and editing the codebase (or use any other code editor of your choice).
Setting Up DevGuard Backend Locally
Step 1: Clone the repository
The repository is located on GitHub.
git clone git@github.com:l3montree-dev/devguard.git && cd devguardStep 2: Copy the .env.example file to .env
cp .env.example .envAdjust the values in the .env file according to your needs.
Step 3: Start the necessary services
Run the following command:
docker compose up -dStep 4: Start the application
Run this command to start the backend:
makeSetting Up DevGuard Frontend Locally
Step 1: Clone the repository
The repository is located on GitHub.
git clone https://github.com/l3montree-dev/devguard-web.gitStep 2: Copy the .env.example file to .env
Adjust the values in the .env file according to your needs.
Step 3: Install NPM packages
Run the following command to install the necessary dependencies:
npm installStep 4: Start the application
Run this command to start the frontend:
npm run dev