Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/StartBootstrap/sb-admin-angular
A free, open source, Angular admin dashboard template, created by Start Bootstrap
https://github.com/StartBootstrap/sb-admin-angular
Last synced: 3 months ago
JSON representation
A free, open source, Angular admin dashboard template, created by Start Bootstrap
- Host: GitHub
- URL: https://github.com/StartBootstrap/sb-admin-angular
- Owner: StartBootstrap
- License: mit
- Created: 2019-12-16T02:55:33.000Z (almost 5 years ago)
- Default Branch: develop
- Last Pushed: 2023-01-06T20:57:56.000Z (almost 2 years ago)
- Last Synced: 2024-05-02T16:09:03.605Z (6 months ago)
- Language: TypeScript
- Homepage: https://startbootstrap.com/templates/sb-admin-angular/
- Size: 1.48 MB
- Stars: 191
- Watchers: 13
- Forks: 202
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://themes.startbootstrap.com/sb-admin-pro-angular/),
so much of the [SB Admin Pro Angular Documentation](https://docs.startbootstrap.com/sb-admin-pro-angular/quickstart) is applicable.
In particular the documentation for [Structure](https://docs.startbootstrap.com/sb-admin-pro-angular/structure-root-level),
and the documentation for [SBPro Schematics](https://docs.startbootstrap.com/sb-admin-pro-angular/development-general#sb-pro-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](https://themes.startbootstrap.com/sb-admin-pro-angular/)
## Quick Start
```bash
git clone [email protected]:startbootstrap/sb-admin-angular.git
cd sb-admin-angular
npm install
npm start
```
`npm start` should open a browser window to
By default angular runs on port 4200. To change this port you can run:
```bash
# 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
```bash
npm run test
```
### e2e
```bash
npm run e2e
```
## Production
SB Admin Angular come with a production ready Dockerfile and build scripts.
You can get Docker [here](https://www.docker.com/get-started)
```bash
npm run docker:build
npm run docker:run
```
## Generate Code
```bash
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 adjust
`max_old_space_size` in the `ng` command of the `package.json`:
```json
"ng": "cross-env NODE_OPTIONS=--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](https://medium.com/@ashleydavis75/node-js-memory-limitations-30d3fe2664c0).
Keep in mind that this project only uses node to build the angular application.
There is no production dependency on node.