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 devguard
# setup git submodules
git submodule update --init --recursive
Step 2: Copy the .env.example
file to .env
cp .env.example .env
cp .kratos/kratos.example.yml .kratos/kratos.yml
Adjust the values in the .env
file according to your needs.
Step 3: Start the necessary services
Run the following command:
docker compose up -d
Keep this running in a seperate terminal.
Step 4: Start the application
Run this command to start the backend:
make
make
will only work sequentially after docker compose up -d
.
Setting Up DevGuard Frontend Locally
Step 1: Clone the repository
The repository is located on GitHub.
git clone https://github.com/l3montree-dev/devguard-web.git
Step 2: Copy the .env.example
file to .env
cp .env.example .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 install
Step 4: Start the application
Run this command to start the frontend:
npm run dev
Where to start
All issues—whether related to the web platform, documentation, or other components—are tracked on Devguard. Each issue is tagged accordingly to help contributors identify relevant tasks.
We mark beginner-friendly issues with the good first issuelabel. These tasks are suitable for newcomers and do not require deep knowledge of our architecture.
If you need assistance or want to connect with the team, feel free to join our Matrix Community Server and reach out directly. The Devguard team is happy to support new contributors.