https://github.com/getbase/starter
Base Starter - A Rock Solid, Starter template that includes the Base CSS framework and modules to get you started on your next app or website.
https://github.com/getbase/starter
Last synced: 11 months ago
JSON representation
Base Starter - A Rock Solid, Starter template that includes the Base CSS framework and modules to get you started on your next app or website.
- Host: GitHub
- URL: https://github.com/getbase/starter
- Owner: getbase
- Created: 2017-08-17T11:57:17.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T02:20:30.000Z (over 3 years ago)
- Last Synced: 2025-06-11T10:26:55.662Z (11 months ago)
- Language: CSS
- Homepage: http://getbase.org
- Size: 1.37 MB
- Stars: 93
- Watchers: 5
- Forks: 21
- Open Issues: 10
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
Awesome Lists containing this project
- awesome-github-projects - starter - Base Starter - A Rock Solid, Starter template that includes the Base CSS framework and modules to get you started on your next app or website. ⭐93 `CSS` (📦 Legacy & Inactive Projects)
README
# [Base Starter](http://getbase.org)
### A Rock Solid, Starter template that includes the Base CSS framework and other goodies.
Start your web / app projects right away. Spend less time with setup and focus more time on writing beautiful styles.
* * *
## Table of contents
* [Overview](#overview)
* [Installation](#installation)
* [Documentation](#documentation)
* [Support](#support)
* [Authors](#authors)
* [License](#license)
* * *
## Overview
Base starter includes a basic index.html template, along with favicons and base styles.
* * *
## Installation
Getting started is easy, simply clone the repo and run the project
```bash
git clone git@github.com:getbase/starter.git --depth=1 your-website \
&& cd your-website && rm -rf .git && npm i && npm start
```
* * *
## Documentation
Base starter includes the latest version of Base to get you started.
Base starter is powered by ParcelJS which compiles SCSS with live reload support, optimises images, compiles and minifies CSS/JS.
There are a series of npm scripts that can perform all the above tasks in a single action. Below is a list of all the npm scripts within the Base Starter package.json.
| NPM Task | Outcome |
| -------- | ------- |
| `npm start` | Starts up a web server and watches for HTML, SCSS and JS changes within `/src` |
| `npm run build` | The build task optmises your website for production |
If you would like to learn more about Base, head over to the [Base website](https://getbase.org).
* * *
## Support
* IE10+ and all other modern browsers.
* * *
## Authors
#### Matthew Hartman
* [https://github.com/matthewhartman](https://github.com/matthewhartman)
* [https://twitter.com/matthewhartmans](https://twitter.com/matthewhartmans)
* * *
## License
Code released under the [MIT Open Source](https://opensource.org/licenses/MIT) license.