https://github.com/grabarzundpartner/gp-boilerplate
https://github.com/grabarzundpartner/gp-boilerplate
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/grabarzundpartner/gp-boilerplate
- Owner: GrabarzUndPartner
- License: mit
- Created: 2017-05-04T08:16:43.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2025-04-12T06:08:49.000Z (about 1 year ago)
- Last Synced: 2025-04-12T07:22:43.396Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://grabarzundpartner.github.io/gp-boilerplate/
- Size: 24.9 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Boilerplate - Grabarz & Partner
[](https://badge.fury.io/gh/GrabarzUndPartner%2Fgp-boilerplate)
[![main][github-workflow-main-src]][github-workflow-main-href]
[![develop][github-workflow-develop-src]][github-workflow-develop-href]
[![Renovate - Status][renovate-status-src]][renovate-status-href]
[](https://david-dm.org/GrabarzUndPartner/gp-boilerplate)
[](https://david-dm.org/GrabarzUndPartner/gp-boilerplate#info=devDependencies)
This boilerplate structure including tasks and servers should help you to develop modular websites + documentation per partial.
## Boilerplate specs
The boilerplate based on [gulp](https://github.com/gulpjs/gulp) and [assemble](https://github.com/assemble/assemble).
## Setup your environment
At first install.
```
npm install
```
The installation process should run without some errors.
### Test the environment
To verify a working environment just run the following command in the root folder of your project.
```
npm test
```
It should build all sources into the 'build'-directory of your project root folder. No error message should be shown in your console.
### Run development-environment
```
npm run dev
```
Url: http://127.0.0.1:8050/dev/
### Run production-environment
```
npm run prod
```
Url: http://127.0.0.1:8050/
### Run production / development with IP
```bash
npm run dev -- --ip=0.0.0.0
```
### Build production-environment
```
npm run build
```
## Documentation
The documentation can be found in the subdirectory "docs".
| Enviroment | Url |
| ---------- | ------------------------------ |
| dev | http://127.0.0.1:8050/dev/docs |
| production | http://127.0.0.1:8050/docs |
[renovate-status-src]:
[renovate-status-href]:
[github-workflow-main-src]:
[github-workflow-main-href]:
[github-workflow-develop-src]:
[github-workflow-develop-href]:
[dependencies-status-src]:
[dependencies-status-href]:
[dependencies-dev-status-src]:
[dependencies-dev-status-href]: