readme.md 1.49 KB
Newer Older
Thodoris Papadopoulos's avatar
Thodoris Papadopoulos committed
1
# Bootstrap Theme Kit: Styling/govgr-bootstrap-theme
Thodoris Papadopoulos's avatar
Thodoris Papadopoulos committed
2

3 4 5
A project to help you get started quickly when developing a website for GOV.GR using Bootstrap.
It includes a project structure with a gulp script that builds a custom CSS version of Bootstrap 4, according to the styling guidelines of GOV.GR
This allows to customize the default GOV.GR bootstrap theme easily, using Sass variables. The result will be a theme that you can apply to new and existing sites based on  Bootstrap 4 projects to give them the new GOV.GR look. 
Thodoris Papadopoulos's avatar
Thodoris Papadopoulos committed
6

Thodoris Papadopoulos's avatar
Thodoris Papadopoulos committed
7 8
## Getting started

9 10 11 12
All the neccessary files reside inside the `Styling/govgr-bootstrap-theme-kit` folder.

### Default theme customization ###
If you want to build your own customized version of the GOV.GR bootstrap theme:
Thodoris Papadopoulos's avatar
Thodoris Papadopoulos committed
13 14 15 16

1. Clone this repo
2. Run `npm install`
3. Run `gulp watch`
17
4. Open `templates/index.html` in a browser to check the default styling.
Thodoris Papadopoulos's avatar
Thodoris Papadopoulos committed
18 19 20 21
4. Add any custom Bootstrap Sass variables into `scss/_custom-variables.scss`
5. Add any custom styles into `scss/_custom-styles.scss`. You can use Bootstrap's mixins here.
6. Repeat steps 4 to 6 until you like what you see :-)

22 23 24 25


### Default theme customization ###
If you simply want to apply the GOV.GR style to your existing or new websites,  you can grab the compiled css file `css/govgr_bootstrap.css` and include it in your site. 
Thodoris Papadopoulos's avatar
Thodoris Papadopoulos committed
26

Thodoris Papadopoulos's avatar
Thodoris Papadopoulos committed
27 28 29 30 31 32 33 34 35 36 37 38 39
## Creators

**GOV.GR Unit**

- <https://gov.gr>

**Bootstrap**

- <https://github.com/twbs/bootstrap/>

## Copyright and license

Code released under the [MIT License](https://opensource.org/licenses/MIT).