/RadiantStore-Backend

NestJs API to RadiantStore

Primary LanguageTypeScript

Table of Contents

Features

  • Database (typeorm).
  • Seeding.
  • Config Service (@nestjs/config).
  • Mailing (nodemailer, @nestjs-modules/mailer).
  • Sign in and sign up via email.
  • JWT Auth
  • Admin and User roles.
  • I18N (nestjs-i18n).
  • File uploads. Support local and Amazon S3 drivers.
  • Swagger.
  • E2E and units tests.
  • Docker.
  • Skins CRUD
  • Initial setup of a e-commerce
  • Order CRUD
  • Add and Remove Skin from Cart
  • Pagination
  • Ordering of query results

Quick run

git clone GIT_REPO_BACKEND backend
git clone GIT_REPO_FRONTEND frontend
cd backend
cp env-example .env
#config it if needed
docker compose up -d

Comfortable development

Change DATABASE_HOST=postgres to DATABASE_HOST=localhost

Change MAIL_HOST=maildev to MAIL_HOST=localhost

Run:

docker compose up -d postgres maildev redis
yarn

yarn migration:run

yarn seed:run

yarn start:dev

Important

If a new user was created, it will not be active. To activate the user, open Maildev and confirm the email.

Links

Database utils

Generate migration

yarn migration:generate -- src/database/migrations/CreateNameTable

Run migration

yarn migration:run

Revert migration

yarn migration:revert

Drop all tables in database

yarn schema:drop

Run seed

yarn seed:run

Tests

Only Skin and Order do not have e2e tests.

# e2e tests
sudo ./test-e2e.sh

Run Over Docker

Required to have cloned backend and frontend with their respective names, at the same folder level

docker compose -f docker-compose.yaml --env-file env-example -p dev up --build --exit-code-from api