AngularNest Fullstack Starter
๐ฏ A boilerplate for Angular, Nest, Material, Express, TypeScript, and ReactiveX.
๐ Live Demo: Develop | Master
Table of Contents
Getting Started
Follow steps to execute this boilerplate.
- Clone this boilerplate
$ git clone --depth 1 https://github.com/Shyam-Chen/AngularNest-Fullstack-Starter <PROJECT_NAME>
$ cd <PROJECT_NAME>
- Install dependencies
$ yarn install
- Set an active project for working direct
$ yarn firebase use development
- Start a local server
# front-end
$ yarn start:app
# back-end
$ yarn start:api
- Compile and bundle code
# front-end
$ yarn build:app
# back-end
$ yarn build:api
- Check the code quality
# front-end
$ yarn lint:app
# back-end
$ yarn lint:api
- Run the unit tests
# front-end
$ yarn test:app
# back-end
$ yarn test:api
- Run the end-to-end tests
# front-end
$ yarn e2e:app
# back-end
$ yarn e2e:api
Key Features
This seed repository provides the following features:
- ---------- Core ----------
- Web Fundamentals
- Firebase Platform
- Google Cloud
- Docker
- CircleCI
- Codecov
- ---------- Front-end ----------
- Angular
- Angular Material
- NGXS
- Webpack
- PostCSS
- StyleLint
- Puppeteer
- ---------- Back-end ----------
- Nest
- Express
- Request
- Gulp
- SuperTest
- ---------- Shared ----------
- Apollo GraphQL
- ReactiveX
- TensorFlow
- TypeScript
- TSLint
- Jest
Dockerization
Dockerize an application.
- Build and run the container in the background
$ docker-compose up -d <SERVICE>
- Run a command in a running container
$ docker-compose exec <SERVICE> <COMMAND>
- Remove the old container before creating the new one
$ docker-compose rm -fs
- Restart up the container in the background
$ docker-compose up -d --build <SERVICE>
- Push images to Docker Cloud
# .gitignore
.DS_Store
node_modules
npm
public
functions
coverage
+ Dockerfile.dev
+ Dockerfile.prod
*.log
$ docker login
$ docker build -f tools/Dockerfile.<dev|prod> -t <IMAGE_NAME>:<IMAGE_TAG> .
# checkout
$ docker images
$ docker tag <IMAGE_NAME>:<IMAGE_TAG> <DOCKER_ID_USER>/<IMAGE_NAME>:<IMAGE_TAG>
$ docker push <DOCKER_ID_USER>/<IMAGE_NAME>:<IMAGE_TAG>
# remove
$ docker rmi <REPOSITORY>:<TAG>
# or
$ docker rmi <IMAGE_ID>
- Pull images from Docker Cloud
# docker-compose.yml
<dev|prod>:
- image: <dev|prod>
- build:
- context: .
- dockerfile: tools/Dockerfile.<dev|prod>
+ image: <DOCKER_ID_USER>/<IMAGE_NAME>:<IMAGE_TAG>
volumes:
- yarn:/home/node/.cache/yarn
tty: true
Configuration
Project environments
Change to your project.
// .firebaserc
{
"projects": {
"development": "<PROJECT_NAME>",
"production": "<PROJECT_NAME>"
}
}
Default environments
Set your local environment variables. (use this.<ENV_NAME> = process.env.<ENV_NAME> || <LOCAL_ENV>;
)
// env.js
function Environments() {
this.NODE_ENV = process.env.NODE_ENV || 'development';
this.PROJECT_NAME = process.env.PROJECT_NAME || '<PROJECT_NAME>';
this.HOST_NAME = process.env.HOST_NAME || '0.0.0.0';
this.SITE_PORT = process.env.SITE_PORT || 8000;
this.SITE_URL = process.env.SITE_URL || `http://${this.HOST_NAME}:${this.SITE_PORT}`;
this.FUNC_PORT = process.env.FUNC_PORT || 5000;
this.FUNC_URL = process.env.FUNC_URL || `http://${this.HOST_NAME}:${this.FUNC_PORT}/${this.PROJECT_NAME}/us-central1`;
this.APP_BASE = process.env.APP_BASE || '/';
this.FIREBASE_CONFIG = process.env.FIREBASE_CONFIG || {
apiKey: process.env.FIREBASE_API_KEY || '<API_KEY>',
authDomain: process.env.FIREBASE_AUTH_DOMAIN || '<FIREBASE_AUTH_DOMAIN>',
databaseURL: process.env.FIREBASE_DATABASE_URL || '<FIREBASE_DATABASE_URL>',
projectId: process.env.FIREBASE_PROJECT_ID || '<FIREBASE_PROJECT_ID>',
storageBucket: process.env.FIREBASE_STORAGE_BUCKET || '<FIREBASE_STORAGE_BUCKET>',
messagingSenderId: process.env.FIREBASE_MESSAGING_SENDER_ID || '<FIREBASE_MESSAGING_SENDER_ID>',
};
this.GOOGLE_ANALYTICS = process.env.GOOGLE_ANALYTICS || '<GOOGLE_ANALYTICS>';
this.SENTRY_DSN = process.env.SENTRY_DSN || null;
this.RENDERTRON_URL = process.env.RENDERTRON_URL || null;
}
Deployment environment
Set your deployment environment variables.
# tools/Dockerfile.<dev|prod>
# envs --
ENV SITE_URL <SITE_URL>
ENV FUNC_URL <FUNC_URL>
# -- envs
CI environment
Add environment variables to the CircleCI build.
CODECOV_TOKEN
DOCKER_PASSWORD
DOCKER_USERNAME
FIREBASE_TOKEN
SEO friendly
Enable billing on your Firebase Platform and Google Cloud the project by switching to the Blaze plan.
Serve dynamic content for bots.
// firebase.json
"rewrites": [
{
"source": "**",
- "destination": "/index.html"
+ "function": "app"
}
],
Deploy rendertron instance to Google App Engine.
$ git clone https://github.com/GoogleChrome/rendertron
$ cd rendertron
$ gcloud auth login
$ gcloud app deploy app.yaml --project <RENDERTRON_NAME>
Set your rendertron instance in deployment environment.
# tools/Dockerfile.<dev|prod>
# envs --
ENV RENDERTRON_URL <RENDERTRON_URL>
# -- envs
Directory Structure
The structure follows the LIFT Guidelines.
.
โโโ src
โ โโโ api
โ โ โโโ __tests__
โ โ โ โโโ ...
โ โ โโโ _<THING> -> api of private things
โ โ โ โโโ ...
โ โ โโโ core -> core feature module
โ โ โ โโโ ...
โ โ โโโ <FEATURE> -> feature modules
โ โ โ โโโ __tests__
โ โ โ โ โโโ <FEATURE>.controller.spec.ts
โ โ โ โ โโโ <FEATURE>.e2e-spec.ts
โ โ โ โโโ _<THING> -> feature of private things
โ โ โ โ โโโ ...
โ โ โ โโโ <FEATURE>.controller.ts
โ โ โ โโโ <FEATURE>.module.ts
โ โ โ โโโ <FEATURE>.service.ts
โ โ โโโ <GROUP> -> module group
โ โ โ โโโ <FEATURE> -> feature modules
โ โ โ โโโ __tests__
โ โ โ โ โโโ <FEATURE>.controller.spec.ts
โ โ โ โ โโโ <FEATURE>.e2e-spec.ts
โ โ โ โโโ _<THING> -> feature of private things
โ โ โ โ โโโ ...
โ โ โ โโโ <FEATURE>.controller.ts
โ โ โ โโโ <FEATURE>.module.ts
โ โ โ โโโ <FEATURE>.service.ts
โ โ โโโ graphql
โ โ โ โโโ <FEATURE> -> feature modules
โ โ โ โ โโโ __tests__
โ โ โ โ โ โโโ ...
โ โ โ โ โโโ _<THING> -> feature of private things
โ โ โ โ โ โโโ ...
โ โ โ โ โโโ ...
โ โ โ โโโ <GROUP> -> module group
โ โ โ โโโ <FEATURE> -> feature modules
โ โ โ โโโ __tests__
โ โ โ โ โโโ ...
โ โ โ โโโ _<THING> -> feature of private things
โ โ โ โ โโโ ...
โ โ โ โโโ ...
โ โ โโโ shared -> shared feature module
โ โ โ โโโ ...
โ โ โโโ api.controller.ts
โ โ โโโ api.module.ts
โ โ โโโ api.service.ts
โ โโโ app
โ โ โโโ __tests__
โ โ โ โโโ ...
โ โ โโโ _<THING> -> app of private things
โ โ โ โโโ ...
โ โ โโโ core -> core feature module
โ โ โ โโโ ...
โ โ โโโ <FEATURE> -> feature modules
โ โ โ โโโ __tests__
โ โ โ โ โโโ <FEATURE>.component.spec.js
โ โ โ โ โโโ <FEATURE>.e2e-spec.js
โ โ โ โโโ _<THING> -> feature of private things
โ โ โ โ โโโ ...
โ โ โ โโโ <FEATURE>.component.css
โ โ โ โโโ <FEATURE>.component.html
โ โ โ โโโ <FEATURE>.component.ts
โ โ โ โโโ <FEATURE>.module.ts
โ โ โโโ <GROUP> -> module group
โ โ โ โโโ <FEATURE> -> feature modules
โ โ โ โโโ __tests__
โ โ โ โ โโโ <FEATURE>.component.spec.js
โ โ โ โ โโโ <FEATURE>.e2e-spec.js
โ โ โ โโโ _<THING> -> feature of private things
โ โ โ โ โโโ ...
โ โ โ โโโ <FEATURE>.component.css
โ โ โ โโโ <FEATURE>.component.html
โ โ โ โโโ <FEATURE>.component.ts
โ โ โ โโโ <FEATURE>.module.ts
โ โ โโโ shared -> shared feature module
โ โ โ โโโ ...
โ โ โโโ app.component.css
โ โ โโโ app.component.html
โ โ โโโ app.component.ts
โ โ โโโ app.module.ts
โ โโโ assets -> datas, fonts, images, medias, styles
โ โ โโโ ...
โ โโโ client.ts
โ โโโ index.html
โ โโโ server.ts
โโโ tools
โ โโโ ...
โโโ .editorconfig
โโโ .firebaserc
โโโ .gitignore
โโโ .postcssrc
โโโ .stylelintrc
โโโ Dockerfile
โโโ LICENSE
โโโ README.md
โโโ circle.yml
โโโ docker-compose.yml
โโโ env.js
โโโ firebase.json
โโโ gulpfile.js
โโโ jest.config.js
โโโ package.json
โโโ tsconfig.api.json
โโโ tsconfig.app.json
โโโ tsconfig.json
โโโ tsconfig.test.json
โโโ tslint.json
โโโ webpack.config.js
โโโ yarn.lock