/node-react-flutter-template

Primary LanguageJavaScript

A Template Repository for Nodejs (server) with React and Flutter (client)

Contains

HTTP (REST API)

  • NodeJs (server) with Express, Typescript and plain SQL
  • ReactJs (client) with Typescript and Axios
  • Database (PostgreSQL Cluster)

GRPC (gRPC API)

  • Go (server) with gRPC and plain SQL
  • gRPC Gateway (proxy) translates REST API to gRPC
  • ReactJs (client) with Typescript and gRPC
  • Flutter (client)
  • Traefik (reverse proxy) -> gRPC-Web

Architecture

gRPC

Template-Arch.drawio

First steps

GRPC

  • server and client uses the .proto files from grpc-proto (npm run proto in both directories)
    • .env file is used to configure the database connection (see .env.example)
  1. Use this repository as template
  2. (optional) Change environment Variables of the database and the the server in docker-compose.yml
  3. Change the name of the project in package.json (server and clients)
  4. Change the name of the project in pubspec.yaml (client-flutter)
  5. Follow the steps in the README of the server and client-reactjs and client-flutter

Environment variables

See the .env.example files and READMEs for more information in the subdirectories.

Server (Server-Nodejs)

Variable Required Description Default Info
DB_HOST_PRIMARY No Primary database host localhost The Primary Host of the Database (Postgres Cluster)
DB_HOST_REPLICA No Replica database host localhost The Replica Host of the Database (Postgres Cluster)
DB_PORT_PRIMARY No Primary database port 5432 The Primary Port of the Database
DB_PORT_REPLICA No Replica database port 5432 The Replica Port of the Database
DB_USER No Database user testuser The user of the Database
DB_PASSWORD No Database password password The password of the Database
DB_DATABASE No Database name testdb The name of the Database
JWT_SECRET No JWT secret secret The secret of the JWT
BCRYPT_ROUNDS No Bcrypt rounds 10 The rounds of the Bcrypt
REDIS_HOST No Redis host redis The host of the Redis
REDIS_PORT No Redis port 6379 The port of the Redis
REDIS_PASSWORD No Redis password The password of the Redis
FRONTEND_URL No Frontend URL http://localhost:80 The URL of the Frontend (CORS)

Volumes

Server (HTTP)

/app/files/avatars/