nest next boilerplate

nichage

Boilerplate pour Nest.js, next.js, pile de typeScript. Comprend les connexions sociales, la vérification du compte, le changement de mot de passe et la récupération, les chats en temps réel et plus encore.

Usage

0. Variables environnementales

0,1. Créer un fichier .env dans le répertoire root server et remplir avec les suivants:

 # APP
NODE_ENV='development'
APP_PORT=4000
ORIGIN='http://localhost:3000'
API_PREFIX='/api'

# JWT AUTH
JWT_ACCESS_SECRET_KEY='long-unpredictable-secret1'
JWT_ACCESS_EXPIRATION_TIME='5m'
JWT_REFRESH_SECRET_KEY='long-unpredictable-secret2'
JWT_REFRESH_EXPIRATION_TIME='30d'

# DATABASE
# change if you running in a different way than the one written in docker compose file
DB_TYPE='postgres'
DB_USERNAME='admin'
DB_PASSWORD='admin'
DB_HOST='postgres-main'
DB_PORT=5432
DB_DATABASE='postgres-nest'
DB_SYNC=true

# REDIS
# change if you running in a different way than docker compose
REDIS_HOST='redis-main'
REDIS_PORT=6379

# GOOGLE
OAUTH_GOOGLE_ID=[YOUR_GOOGLE_OAUTH_ID]
OAUTH_GOOGLE_SECRET=[YOUR_GOOGLE_SECRET]
OAUTH_GOOGLE_REDIRECT_URL='/api/v1/auth/google/redirect'

# FACEBOOK
OAUTH_FACEBOOK_ID=[YOUR_FACEBOOK_ID]
OAUTH_FACEBOOK_SECRET=[YOUR_FACEBOOK_SECRET]
OAUTH_FACEBOOK_REDIRECT_URL='/api/v1/auth/facebook/redirect'

0,2. Créer un fichier .env dans le répertoire root workers/queues et remplissez-le avec:

 # MAIL
SMTP_USER=[YOUR_SMTP_USER]
SMPT_PASSWORD=[YOUR_SMTP_PASSWORD]

# REDIS
# change if you running in a different way than docker compose
REDIS_HOST='redis-main'
REDIS_PORT=6379

Conseil

Pour les tests de messagerie gratuits, vous pouvez utiliser un service tel que MailTrap.

Avec Docker

1. Exécutez des conteneurs Docker

docker compose up 

Sans docker

1. Modifier les contenus de DATABASE et des sections REDIS dans les fichiers env

server

 ...

# DATABASE
DB_TYPE=[YOUR_DB_TYPE]
DB_USERNAME=[YOUR_DB_USERNAME]
DB_PASSWORD=[YOUR_DB_PASSWORD]
DB_HOST=[YOUR_DB_HOST]
DB_PORT=[YOUR_DB_PORT]
DB_DATABASE=[YOUR_DB_DATABASE]
DB_SYNC=[true or false in dev mode, false in prod]

# REDIS
REDIS_HOST=[YOUR_REDIS_HOST]
REDIS_PORT=[YOUR_REDIS_PORT]

...

workers/queues

 ...

# REDIS
REDIS_HOST=[YOUR_REDIS_HOST]
REDIS_PORT=[YOUR_REDIS_PORT]

2.1 Configuration du serveur

 cd server 

npm install 
# OR 
pnpm install 
# OR 
yarn

2.2 travailleur

 cd workers/queues

npm install 
# OR 
pnpm install 
# OR 
yarn

3. Configuration du client

 cd client 

npm install 
# OR 
pnpm install 
# OR 
yarn

CARACTÉRISTIQUES

• Connexion locale et enregistrement
• Connexion sociale et inscription à l'aide de Google et Facebook
• Jeton de jeton d'accès JWT et de rafraîchissement
• Confirmation du compte
• Mot de passe récupérer
• Mise à jour du profil
• Plusieurs thèmes avec la possibilité d'ajouter le vôtre
• Chat de groupe avec les autorisations de base
• Chat privé (aussi avec vous-même)
• Limitation des taux

Pile technologique

• Backend:
  • Nest.js
  • Postgresql
  • Redis
  • Sockets websockets
  • JWT
  • Passport.js
• L'extrémité avant
  • Next.js
  • Aile à queue et marguerite
  • Redux (revanche)

FAIRE

• Connexion locale
• Connexion Google
• Connexion Facebook
• Routage des applications client
• Écrire des tests pour l'API
• Fonctionnalités de récupération et de modification du mot de passe
• Files d'attente
• Rafraîchir les jetons
• Chat
• Faire un aperçu de l'URL
• Activer l'envoi d'images et peut-être des vidéos
• Page de profil public
• Refactor Chat Backend & UI

Licence

Mit