Skip to content

Commit 7713f08

Browse files
dariusrosendahldariusrosendahl
authored
Merge pull request #1 from CastleCSS/feature/boilerplate-init
Setting up the Boilerplate
2 parents af1e697 + a2b47a2 commit 7713f08

File tree

15 files changed

+491
-202
lines changed

15 files changed

+491
-202
lines changed

‎README.md‎

Lines changed: 49 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,80 +1,74 @@
1-
# CastleCSS (Full package)
2-
A modular, updatable, easy to use HTML and SCSS framework.
1+
# CastleCSS Boilerplate
2+
[CastleCSS](https://github.com/CastleCSS/) is a modular, updatable and easy to use HTML and SCSS framework.
3+
Use this Boilerplate to get started with your project right away!
34

45
![CastleCSS logo @CastleCss.com](https://www.doordarius.nl/castlecss-logo-250.png)
56

67
## What's included?
7-
Included in this package:
8-
- Example project setup
9-
- Gruntfile.js and tasks
8+
- A simple and mobile-friendly HTML5 template to kickstart your website
9+
- Configuration for Grunt, to easily compile and minify your Sass files
1010
- [castlecss-core](https://github.com/CastleCSS/castlecss-core)
1111
- [castlecss-buttons](https://github.com/CastleCSS/castlecss-buttons)
1212
- [castlecss-notifications](https://github.com/CastleCSS/castlecss-notifications)
13-
- [castlecss-docs (documentation)](https://github.com/CastleCSS/castlecss-docs)
1413

15-
## How to install
16-
CastleCSS is built with easy updating in mind.
17-
You can download the full package and make adjustments as long as you don't update the dependencies (core, buttons, notifications and docs). When you decide to adjust the dependencies, you will lose them with the next update.
14+
## Get started
15+
1. Clone ```git clone https://github.com/CastleCSS/castlecss.git``` or [download](https://github.com/CastleCSS/castlecss-boilerplate/archive/master.zip) CastleCSS Boilerplate.
16+
2. Set up your project directory and a basic site structure.
17+
3. Run Grunt from your directory by typing ```Grunt``` in the commandline. If you haven't used Grunt before, be sure to check out the Getting Started guide.
18+
4. Add some content, do some styling and include functionality.
19+
5. Run your site locally and see how it all works out!
1820

19-
There are a few ways to install:
21+
## Basic structure
22+
The basis structure for your website should look similar like this:
2023

21-
- [Download the latest release](https://github.com/CastleCSS/castlecss/archive/master.zip)
22-
- Clone the package ```git clone https://github.com/CastleCSS/castlecss.git```
23-
- Install via [npm](https://www.npmjs.com/): ```npm install castlecss```
24-
- Add it to your package.json in your own npm package
25-
26-
When downloading or cloning CastleCSS, you have to run ```npm install``` from the directory to get the full package (core, buttons, notifications and docs).
27-
28-
## Updating files
29-
30-
NOTE: Only update the dependencies so that you don't overwrite your own SCSS files. If you do update the full package you'll overwrite everything.
31-
32-
We recommend downloading the full package and updating the dependencies like:
33-
```
34-
npm update castlecss-core
35-
npm update castlecss-buttons
36-
npm update castlecss-notifications
37-
npm update castlecss-docs
3824
```
39-
40-
## Documentation and examples
41-
You can find the documentation and examples at http://www.castlecss.com and included in this package (castlecss-docs)
42-
43-
## Setup
44-
Your project should have a setup similair to this (included in the Full package):
45-
With this you make sure your own variables overwrite the castle-core variables and your setup is still updatable.
46-
47-
```
48-
| Your project/
25+
| Project directory/
4926
|
27+
|-- node_modules/
28+
| | -- castlecss-core/
29+
| | --castlecss-buttons/
30+
| | --castlecss-notifications/
31+
| |
5032
|-- scss/
51-
| |-- /* Custom project specific scss files here */
5233
| |-- main.scss
34+
| |-- variables.scss
5335
| |
54-
|-- node_modules/
36+
|-- img/
37+
|-- dist/
38+
| |-- styles.min.css
39+
| |-- styles.min.map
5540
| |
56-
| | /* CastleCSS files included automatically here */
57-
| | castlecss-core/
58-
| | castlecss-buttons/
59-
| | castlecss-etc ;)/
41+
|-- index.html
42+
|-- Gruntfile.js
43+
|-- package.json
6044
```
6145

6246
### main.scss
63-
Your main.scss should have a setup similar to this (included in the [CastleCSS (Full package)](https://github.com/CastleCSS/castlecss)):
47+
Your main.scss should have the following set-up:
6448

6549
```
66-
/* castlecss variable files */
67-
@import "path/to/castlecss-core/sass/variables";
68-
50+
/* CastleCSS Core variables */
51+
@import "node_modules/castlecss-core/sass/variables";
6952
70-
/* Your own variables so they overwrite the core */
53+
/* Your variables */
7154
@import "variables";
72-
/* rest of castle files */
73-
@import "path/to/castlecss-core/sass/main";
74-
@import "path/to/castlecss-buttons/sass/variables";
75-
@import "path/to/castlecss-notifications/sass/variables";
7655
77-
/* Include your own files below this line
78-
--------------------------------------
79-
*/
56+
/* Remaining Core files and other CastleCSS modules */
57+
@import "node_modules/castlecss-core/sass/main";
58+
@import "node_modules/castlecss-buttons/sass/main";
59+
@import "node_modules/castlecss-notifications/sass/main";
60+
61+
/* Include your own files below this line
62+
-------------------------------------- */
63+
64+
65+
66+
/* --------------------------------------
67+
Include your own files above this line */
68+
69+
@import "node_modules/castlecss-core/sass/base/utility";
70+
@import "node_modules/castlecss-core/sass/base/utility_spacers";
8071
```
72+
73+
## Documentation and examples
74+
Check out http://www.castlecss.com for an extended documentation and more examples!

‎clean.html‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<!-- Basic Page Needs -->
5+
<meta charset="utf-8">
6+
<title>Your page title - CastleCSS Clean Boilerplate</title>
7+
<meta name="description" content="">
8+
<meta name="author" content="">
9+
10+
<!-- Mobile Specific Metas -->
11+
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no, maximum-scale=1" />
12+
13+
<!-- Fonts -->
14+
<link href="https://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet">
15+
16+
<!-- CSS -->
17+
<link rel="stylesheet" href="dist/css/styles.min.css" />
18+
19+
<!-- Favicon -->
20+
<link rel="icon" type="image/png" href="img/favicon.png">
21+
</head>
22+
<body>
23+
<div class="wrapper">
24+
<div class="header">
25+
</div>
26+
<section class="p">
27+
<div class="container">
28+
<div class="g">
29+
<div class="b0_12">
30+
<h1>Basic Page</h1>
31+
<p>
32+
This clean.html page is a placeholder with the CSS, font and favicon. Let's add some content!
33+
</p>
34+
<p>
35+
Need help setting things up? Check out the <a href="index.html" target="_blank">CastleCSS examples and layout</a> included in this package to speed things up a bit.
36+
</p>
37+
<p>
38+
Or take a look at the documentation over at <a href="http://www.castlecss.com" target="_blank">www.castlecss.com</a>.
39+
</p>
40+
</div>
41+
</div>
42+
</div>
43+
</section>
44+
</div>
45+
</body>
46+
</html>

‎dist/css/styles.min.css‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎img/favicon.png‎

1.93 KB
Loading

‎img/logo.png‎

8.18 KB
Loading

‎img/logo.svg‎

Lines changed: 52 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)