README.md

March 25, 2021 · View on GitHub

logo svvs

documentation

SVVS is an open source project and YouTube channel showcasing application development in the Nx mono repository.

The SVVS project includes

  • backend-api server
  • PostgreSQL db
  • frontend client app
  • frontend admin app
  • a set of libraries

Technologies used

NxNestJsGraphQLDockerPostgreSQLAngularBootstrapangular.material

Documentation

backend-apifrontend-clientfrontend-admin


📌 How to start

  • Clone repo

  • Rename .example.env => .env

  • run docker daemon (e.g. macOS you can use Docker Desktop )

  • if necessary

    • change .env data
yarn install                   // install dependensies
yarn run db:start              // create database
yarn run db:entites            // apply entities
yarn run db:migrations:run     // apply migration
yarn run backend-api:start     // start backend server
  • fix Observable warning Apollo

Before run angular app find

node_modules/@apollo/client/utilities/observables/Observable.js

replace

import { Observable } from "zen-observable";

to

import { Observable } from "zen-observable-ts";

  • Run frontend application
yarn run frontend-client:start // start frontend client 
yarn run frontend-admin:start // start frontend admin 

⚠️ IMPORTANT

This repository contains github action .github/workflows/generateDocs.yml This action generates up-to-date project documentation with a pull request or a commit to a branch master To activate these actions:

generate your personal access token

create encrypted secrets with a name "ACTION_GH_PAGE"

...or delete .github/workflows/generateDocs.yml


Tags:

To bring the repository into the state corresponding to the selected tag, run

git checkout -TAG_NAME-

available tags

  • v0.1.0 init svvs workspace with backend-api and frontend client & admin app