Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bartoszpiwek/frontbox
Static WWW builder tool
https://github.com/bartoszpiwek/frontbox
components css-modules pug scss static-site-generator typescript webpack
Last synced: 23 days ago
JSON representation
Static WWW builder tool
- Host: GitHub
- URL: https://github.com/bartoszpiwek/frontbox
- Owner: BartoszPiwek
- Created: 2020-09-08T11:39:11.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-02-27T19:25:52.000Z (almost 3 years ago)
- Last Synced: 2024-10-16T17:17:21.804Z (2 months ago)
- Topics: components, css-modules, pug, scss, static-site-generator, typescript, webpack
- Language: TypeScript
- Homepage:
- Size: 1.82 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# FrontBox
Static WWW builder tool. Connect prepared components to create hermetic website.
## Table of contents
- [Playground](#playground)
- [Preview/Status](#previewstatus)
- [Information](#information)
- [Requirements](#requirements)
- [Visual Studio Code addons](#visual-studio-code-addons)
- [Terminal tasks](#terminal-tasks)
- [Projekt Tree](#projekt-tree)
- [Bugs](#bugs)
## Playground
[](https://codesandbox.io/s/github/BartoszPiwek/FrontBox/tree/master/)
## Preview/Status
| Type | Badge |
| ----------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| [Productive](https://frontbox.netlify.app) |  |
| [Documentation](https://frontbox-documentation.netlify.app) |  |
## Information
| | |
| ---------- | -------------------------------------------- |
| Author | Bartosz Piwek |
| Version | 0.1.0 |
| HTML | [Pug](https://pugjs.org/) |
| CSS | [SCSS](https://sass-lang.com) |
| JavaScript | [TypeScript](https://www.typescriptlang.org) |
### Partial list of npm packages:
| Package | Description |
| ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [FrontBox-Style](https://github.com/BartoszPiwek/FrontBox-Style) | Hermetic SCSS files contain helpful methods used on most websites, divided into categories: functions, generators, modules, shapes, styles, variables. |
| [scroll-lock](https://www.npmjs.com/package/scroll-lock) | Cross-browser JavaScript library to disable scrolling page |
| [vh-check](https://www.npmjs.com/package/vh-check) | Get reliable CSS vh sizes |
## Requirements
| | |
| --------------------------------------------------- | ------------------------------------- |
| [Node.js](https://nodejs.org/en) | JavaScript run-time environment |
| [Webpack](https://webpack.js.org/) | Module bundler |
| [Yarn](https://yarnpkg.com) | Fast, reliable, and secure dependency |
| [Visual Studio Code](https://code.visualstudio.com) | IDE |
### Visual Studio Code addons
| Plugin | Description |
| --------------------------------------------------------------------------------------------- | --------------------------- |
| [Stylelint](https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint) | Modern CSS/SCSS/Less linter |
| [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) | Code formatter |
| [Pug beautify](https://marketplace.visualstudio.com/items?itemName=mrmlnc.vscode-pugbeautify) | Simple Pug/Jade beautify |
## Terminal tasks
| Task | Description |
| ---------- | ----------------------------------------------------------------------- |
| yarn start | Generate website with server and automatic update after modifying files |
| yarn build | Generate prod website |
## Projekt Tree
```
├─── content | Text content
├─── dist | Generated website
├─── dosc | Documentation
└─── src/
├─── components | Components {ts, pug, scss}
├─── modals | Modals content {ts, pug}
├─── pages | Pages {pug}
├─── scripts/
├─── abstract | Abstract classes
├─── app | Custom js/ts plugins folder
├─── bootstrap | Framework classes
├─── tools | Framework tools
└─── ...
├─── services | Services
├─── static/ | Static assets
├─── audios
├─── fonts
├─── icons
├─── images
└─── videos
├─── style/
├─── global
├─── utilities
├─── variables
├─── global.scss
├─── utilities.scss
└─── variables.scss
├─── template | Pug extends files
└─── utilities | Pug utilities
```
## Bugs
Feel free to [create bug issues](https://github.com/BartoszPiwek/FrontBox/issues/new?labels=bug).