SB Admin Angular

SB Admin Angular is a free and open-sourced Bootstrap themed Angular 9 starter project.

It shares the same project structure and subset of tooling from our professional offering, SB Admin Pro Angular, so much of the SB Admin Pro Angular Documentation is applicable.

In particular the documentation for Structure, and the documentation for SBPro Schematics

SB Admin Angular comes with a base implementation of navigation and layouts.

For professionally designed components (including an advanced SideNav), 100% code coverage, starter cypress tests and more, please consider our professional offering: SB Admin Pro Angular

Quick Start

step1: clone project
git clone git@github.com:startbootstrap/sb-admin-angular.git
step2:
cd sb-admin-angular
npm install
step3:
go to modules\bootstrap\scss and change _variables.scss 
step4:
npm start
ng -- serve --port 4200 --open

npm start should open a browser window to http://localhost:4200

By default angular runs on port 4200. To change this port you can run:

# This starts the development server on port 4205,
# but you can use any port you'd like
export PORT=4205 && npm start

Tests

Unit Tests

npm run test

e2e

npm run e2e

Production

SB Admin Angular come with a production ready Dockerfile and build scripts.

You can get Docker here

npm run docker:build
npm run docker:run

Generate Code

npm run generate:module -- --path src/modules --name Test
npm run generate:component -- --path src/modules/test/containers --name Test
npm run generate:component -- --path src/modules/test/components --name Test
npm run generate:directive -- --path src/modules/test/directives --name Test
npm run generate:service -- --path src/modules/test/services --name Test

Note: Creating a Component and a Container use the same command, the difference is just the paths and how they are used.

MVCC

Containers and Components are both Angular Components, but used in different ways.

Containers should arrange Components.

Obviously this can become subjective, but MVCC is the paradigm that we subscribe to.

Troubleshooting

npm start

If you receive memory issues (most likely on Linux, but could technically happen on any system) adjust max_old_space_size in the ng command of the package.json:

"ng": "node --max_old_space_size=2048 ./node_modules/.bin/ng",

You can adjust 2048 to any number you need.

For more information about why you may need --max_old_space_size see this article.

Keep in mind that this project only uses node to build the angular application. There is no production dependency on node.

saruharu / sbofront