simplebank

Start the development server with hot-reloading enabled.

npm run dev

Execute the project's unit tests using Vitest.

npm run test:unit

Run the production build process. This includes type-checking using vue-tsc (instead of tsc) to ensure .vue file type support, followed by compilation and minification.

npm run build

To ensure proper type support for .vue imports in TypeScript, use the following setup:

1. IDE: Use VSCode.
2. Extension: Install Volar.
3. Disable Vetur: Ensure the Vetur extension is disabled to avoid conflicts.

Install the project dependencies using npm.

npm install

Run the ESLint linter to check for code quality and style issues.

npm run lint

The main function serves as the entrypoint for the SimpleBank application. When executed, it performs the following sequence:

1. Loads configuration from the current directory using util.LoadConfig.
2. Initializes a PostgreSQL connection pool using pgxpool.
3. Runs database migrations using runDBMigration.
4. Initializes the database store via db.NewStore.
5. Sets up a Redis task distributor for background workers.
6. Starts three concurrent services using an errgroup:
   • Task Processor: Handles background tasks (e.g., sending emails via Gmail).
   • gRPC Server: Provides the core gRPC API.
   • HTTP Gateway Server: Provides a RESTful JSON API via gRPC-Gateway, including Swagger documentation and CORS support.

The application handles graceful shutdowns for all services upon receiving os.Interrupt, syscall.SIGTERM, or syscall.SIGINT.

The api service can be configured using environment variables to define database connectivity and Redis addressing. The service builds from the local Dockerfile and exposes ports 8080 and 9090.

api:
  build:
    context: .
    dockerfile: Dockerfile
  ports:
    - "8080:8080"
    - "9090:9090"
  environment:
    - DB_SOURCE=postgresql://root:secret@postgres:5432/simple_bank?sslmode=disable
    - REDIS_ADDRESS=redis:6379

The postgres service uses the postgres:14-alpine image. You can configure the database credentials and name using the following environment variables:

• POSTGRES_USER: The database user (default: root)
• POSTGRES_PASSWORD: The database password (default: secret)
• POSTGRES_DB: The database name (default: simple_bank)

Data is persisted using the data-volume volume.

postgres:
  image: postgres:14-alpine
  environment:
    - POSTGRES_USER=root
    - POSTGRES_PASSWORD=secret
    - POSTGRES_DB=simple_bank
  ports:
    - "5432:5432"
  volumes:
    - data-volume:/var/lib/postgresql/data

The redis service uses the redis:7-alpine image and is available to the api service at the hostname redis on port 6379.

redis:
  image: redis:7-alpine

The runTaskProcessor function initializes and starts the background worker system. It uses a Redis-based task distributor and a Gmail sender for email tasks.

Parameters:

• ctx: Context for lifecycle management.
• waitGroup: An errgroup.Group to manage the processor's lifecycle.
• config: The application configuration (util.Config).
• redisOpt: Redis client options (asynq.RedisClientOpt).
• store: The database store (db.Store).

When the provided ctx is cancelled, the function triggers a graceful shutdown of the taskProcessor.

func runTaskProcessor(
	ctx context.Context,
	waitGroup *errgroup.Group,
	config util.Config,
	redisOpt asynq.RedisClientOpt,
	store db.Store,
)