Giter Club home page Giter Club logo

metaphorv2's Introduction

Metaphor V2

This is a custom Bootstrap 4 theme with CSUN branding.

What this project does

This repository includes a project structure with a build script that builds a custom CSS version of Bootstrap 4 using Gulp.

Also included in this repository is the docs for MetaphorV2, which are served up here using github pages and powered by VuePress.

Prerequisites

  • This works on Windows, macOS and Linux.
  • Node Package Manager and Gulp are required. Make sure you can run gulp -v and npm -v.
  • You can get Node at nodejs.org, then install gulp using npm install gulp-cli -g

Getting started

Editing the booststrap theme itself

  1. Clone this repo
  2. Run npm install
  3. Run gulp watch (and then leave that terminal window reserved for the gulp watcher to run)
  4. If you encounter any errors, consider changing your version of node (nvm is a useful tool for this.) Version 8.10.0 is confirmed to work.
  5. Look at index.html (ideally with a local development webserver)
  6. Edit any of the .scss or .js files within the src directory as desired

Publishing an update of the theme to NPM

  1. Make any desired changes to the theme (see above instructions)
  2. Update the version number in package.json
  3. Commit changes to github
  4. Run npm publish

Editing the docs (which are powered by VuePress)

  1. Run npm run docs:dev
  2. If you encounter any errors, consider changing your version of node (nvm is a useful tool for this.) Version 8.10.0 is confirmed to work.
  3. Edit any of the README.md files within the docs directory as you see fit.

Publishing updates to the docs

  1. Run bash deploy.sh

License

The project is open source and under the GNU General Public License v3+. A copy can be found in the COPYING file.

metaphorv2's People

Contributors

luisjg avatar

Watchers

 avatar  avatar  avatar

Forkers

tiffufu

metaphorv2's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.