Getting Started

Overview

Thanks for choosing our theme. This guide will help you start using it.

Information regarding file structure, build tools, components, credits, and license are here.

Please feel free to contact us with any questions you might have that can't be answered using the documentation.

Please Note:

  • Requests conducted outside regular business hours will be attended to on the next available business day.
  • Support is for issues regarding theme features. Unfortunately, support does not include custom modifications or debugging.
File Structure

Below is a visual overview of the file structure. Each folder comes with a description.

                        
good-vibrations/
├── dist/
├── production/
├── src/
│   ├── documentation/
│   ├── img/
│   ├── js/
│   └── scss/
├── package-lock.json
└── package.json

dist Contains the project compiled files upon running the start command (see more about commands below).

production Contains the project compiled files upon running the build command (see more about commands below).

package-lock.json Contains the list of dependencies including node modules.

package.json Contains the list of dependencies to install from NPM along with Parcel commands.

src All the theme's main source files like HTML, SCSS, IMG, and JS before they are compiled and minified.

  • src / documentation Contains all the HTML files related to the theme's documentation.

  • src / js Contains main.js (imports Bootstrap js), custom JS and third-party vendor JS files. If you don't want to use scripts simply remove any references to them on individual pages and recompile.

  • src / scss Contains the main styles.scss file and all the related scss files.

  • src / img Contains the images used within the theme.

Installation

This is a Bootstrap theme. As such, we are assuming you are comfortable with installing a development version of the theme.

We're using Parcel as our build tool. Check out Bootstrap's documentation on using Parcel.

Let's begin...

  1. Open your code editor. For example, we're using VS Code.
  2. Open theme folder in VS Code.
  3. Open a new terminal in VS Code.
  4. Ensure you have Node/NPM installed. In your terminal type node -v and press Enter. If node is installed you should see a version number appear in the terminal. Follow the same steps with NPM except type npm -v and press Enter.
  5. In your terminal type npm install and press Enter. This installs the project modules.
  6. Now type npm run start and press Enter. This will start a development version hosted locally. Something like http://localhost:1234 will appear in your browser.
Commands

npm run start will create a development version of your project. You can see the hosted files in the dist folder.

npm run build will create a production version of your project. You can see the hosted files in the production folder.

control + c on the keybaord will kill the server and return terminal operation.