https://github.com/jeffrey-allan-brown/urchin

:ice_cream: HTML component and module toolkit for starting projects.
https://github.com/jeffrey-allan-brown/urchin

gulp html5 javascript nodejs pug scss toolkit urchin

Last synced: 27 days ago
JSON representation

:ice_cream: HTML component and module toolkit for starting projects.

• Host: GitHub
• URL: https://github.com/jeffrey-allan-brown/urchin
• Owner: jeffrey-allan-brown
• License: mit
• Created: 2020-11-10T10:34:26.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-10-08T17:17:15.000Z (about 3 years ago)
• Last Synced: 2023-03-08T03:35:28.901Z (almost 2 years ago)
• Topics: gulp, html5, javascript, nodejs, pug, scss, toolkit, urchin
• Language: Pug
• Homepage:
• Size: 4.7 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


[![Development Status](https://img.shields.io/static/v1?label=status&message=Active Development&color=purple&style=flat-square&logo=open-source-initiative&logoColor=ffffff)](#) [![Version](https://img.shields.io/github/v/release/hieronymous-bean/urchin?include_prereleases&style=flat-square)](#) [![Issues](https://img.shields.io/github/issues-raw/hieronymous-bean/urchin?style=flat-square)](#) [![License](https://img.shields.io/github/license/hieronymous-bean/urchin?style=flat-square)](#)

[![built with gulp](https://img.shields.io/badge/gulp-builds_this_project-eb4a4b.svg?logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAAAYAAAAOCAMAAAA7QZ0XAAAABlBMVEUAAAD%2F%2F%2F%2Bl2Z%2FdAAAAAXRSTlMAQObYZgAAABdJREFUeAFjAAFGRjSSEQzwUgwQkjAFAAtaAD0Ls2nMAAAAAElFTkSuQmCC&style=flat-square)](http://gulpjs.com/)

:ocean: Full component and module toolkit for starting HTML-based projects. 

## Table of Contents

- [Introduction](#introduction)

- [System Requirements](#system-requirements)

- [Quick Start](#inbox_tray-quick-start)

- [Build Tools](#build-tools)

- [Configuration](#configuration)

- [Sources & Credits](#credits)

- [License](#license)

- [Support](#support)

## Introduction

Urchin was developed to give beginner developers a way to quickly create a front-end interface without having to comb through hundreds of lines of source code and insert their own information. Using Urchin, all a user needs to do is update the configuration file with their preferred settings and run the setup command. Urchin takes care of the rest, and builds a fully-populated set of files that are ready-to-use and easy to understand. 

## System Requirements

At its core, Urchin relies on Node.js and NPM for its core functionality. 

- Node.js ~14.15.0

- NPM ~6.14.8

Urchin uses a core set of packages for its functionality:

*Focus*                             |  *Tool(s)*

------------------------------------|------------------------------------------------------------------------------------

Engine                              | Node.js

Primary Functions                   | Javascript

Build and Deployment Automation     | Gulp

View Engine                         | Pug

Front-End                           | Bootstrap

Styling                             | SCSS

## :inbox_tray: Quick Start

To get started, first go to the `config.json` file and edit the configuration objects, adding your personal information and application build preferences. A full list of configuration options and their expected values will be provided later. 

Then, run the setup script from the root directory to build the application and load all required assets.

```

npm run setup

```

This will install all required modules, run Gulp task automation, and compile application components. It also compiles all Pug templates into their HTML equivalents, with all variables prep-populated with the data entered in `config.json`. 

## Build Tools

Gulp

## Configuration

## Sources & Credits

## Support