Copilot Instructions for NT208 - Chính quyền điện tử PKI

This document provides guidance for AI coding agents working on this project. It outlines the architecture, workflows, and conventions specific to this codebase to ensure productivity and alignment with project goals.

Project Overview

This project implements an electronic government system leveraging Public Key Infrastructure (PKI). It consists of a backend built with Django and Django REST Framework (DRF) and a frontend built with React.

Key Components

Backend:
- Located in the
```
backend/
```
  directory.
- Major apps:
  - ```
  authentication
```
  : Handles user authentication and authorization.
- ```
hoso
```
    : Manages document-related operations.
  - ```
  social_auth
```
  : Integrates social login (Google, Facebook, etc.).
- Configuration files:
  - ```
  backend/chinhquyendtPKI_djangov2/settings.py
```
  : Main Django settings.
- Database: PostgreSQL is used as the database backend.
Frontend:
- Located in the
```
frontend/
```
  directory.
- Key directories:
  - ```
  src/components/
```
  : Contains reusable React components.
- ```
src/container/
```
    : Defines page-level components and templates.
  - ```
  src/redux/
```
  : Manages global state using Redux.
Static Files:
- Backend static files:
```
backend/static/
```
- Frontend assets:
```
frontend/public/
```
  and
```
frontend/src/assets/
```

Data Flow

The frontend communicates with the backend via REST APIs.
Authentication uses token-based mechanisms (e.g., JWT).
Social authentication is integrated via
```
social_auth
```
.

Developer Workflows

Backend

Setup:

Install dependencies:

pip install -r backend/requirements.txt

Configure PostgreSQL:

CREATE USER <username> WITH PASSWORD '<password>';
CREATE DATABASE <dbname> OWNER <username>;

Run the Server:

python manage.py makemigrations
python manage.py migrate
python manage.py runserver

Create a Superuser:

python manage.py createsuperuser

Testing:

Tests are located in
```
tests.py
```
files within each app.

Run tests:

python manage.py test

Frontend

Setup:
- Install dependencies:
```
npm install
```
Run the Development Server:
```
  npm start
```
Build for Production:
```
  npm run build
```

Project-Specific Conventions

Backend:
- Follow Django's app structure.
- Use serializers for data validation and transformation.
- Place utility functions in
```
utils.py
```
  .
Frontend:
- Use functional components with hooks.
- Organize styles in
```
scss/
```
  .
- Follow the container-component pattern.
General:
- Use meaningful commit messages.
- Document code with comments where logic is complex.

Integration Points

Social Authentication:
- Implemented in
```
backend/social_auth/
```
  .
- Supports Google and Facebook login.
PDF Signing:
- Managed in
```
backend/signpdf.py
```
  .
Pagination:
- Custom pagination logic in
```
backend/hoso/paginator.py
```
  .

External Dependencies

Backend:
- ```
django-cors-headers
```
  : Handles CORS.
- ```
djoser
```
  : Simplifies user authentication.
- ```
django-x509
```
  : Manages PKI certificates.
Frontend:
- React, Redux, and SCSS for styling.

References

Project Overview

Backend:

Located in the
```
backend/
```
directory.
Major apps:
- ```
authentication
```
  : Handles user authentication and authorization.
- ```
hoso
```
  : Manages document-related operations.
- ```
social_auth
```
  : Integrates social login (Google, Facebook, etc.).

Configuration files:

backend/chinhquyendtPKI_djangov2/settings.py

: Main Django settings.

Database: PostgreSQL is used as the database backend.

Frontend:

Located in the
```
frontend/
```
directory.
Key directories:
- ```
src/components/
```
  : Contains reusable React components.
- ```
src/container/
```
  : Defines page-level components and templates.
- ```
src/redux/
```
  : Manages global state using Redux.

Static Files:

Backend static files:
```
backend/static/
```
Frontend assets:
```
frontend/public/
```
and
```
frontend/src/assets/
```

The frontend communicates with the backend via REST APIs.

Authentication uses token-based mechanisms (e.g., JWT).

Social authentication is integrated via

social_auth

Developer Workflows

Setup:

Install dependencies:

pip install -r backend/requirements.txt

Configure PostgreSQL:

CREATE USER <username> WITH PASSWORD '<password>';
CREATE DATABASE <dbname> OWNER <username>;

Run the Server:

python manage.py makemigrations
python manage.py migrate
python manage.py runserver

Create a Superuser:

python manage.py createsuperuser

Testing:

Tests are located in
```
tests.py
```
files within each app.

Run tests:

python manage.py test

Setup:

Install dependencies:
```
npm install
```

Run the Development Server:

  npm start

Build for Production:

  npm run build

Copilot Instructions for NT208 - Chính quyền điện tử PKI

Copilot Instructions for NT208 - Chính quyền điện tử PKI

Project Overview

Key Components

Data Flow

Developer Workflows

Backend

Frontend

Project-Specific Conventions

Integration Points

External Dependencies

References

Related Skills

Markdown Converter

Nano Banana Pro

1password

Copilot Instructions for NT208 - Chính quyền điện tử PKI

Project Overview

Key Components

Data Flow

Developer Workflows

Backend

Frontend

Project-Specific Conventions

Integration Points

External Dependencies

References