https://github.com/srm985/static-website-template

A simple template to conceptually demo the creation of a static website without the use of frameworks. Useful for teaching the basics.
https://github.com/srm985/static-website-template

Last synced: 7 days ago
JSON representation

A simple template to conceptually demo the creation of a static website without the use of frameworks. Useful for teaching the basics.

• Host: GitHub
• URL: https://github.com/srm985/static-website-template
• Owner: srm985
• Created: 2020-01-09T22:18:59.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T05:00:54.000Z (almost 2 years ago)
• Last Synced: 2024-04-15T00:02:15.268Z (7 months ago)
• Language: HTML
• Size: 3.93 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 25
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Static Website Template

#### A simple template to conceptually demo the creation of a static website without the use of frameworks. Intended to serve as a teaching aid.

## How It Works

This template allows you to bundle HTML, CSS (SCSS), and JavaScript, and other static assets into a static website bundle, ready to be deployed to your server of choice.

#### Install Dependencies

This template leverages [Node.js](https://nodejs.org/) to handle all development and build tasks. You'll need to [install Node.js](https://nodejs.org/en/download/) prior to proceeding. It is suggested that you simply pick the `LTS` option.

#### Executing Scripts

All development and build scripts are executed through a utility called [NPM](). This utility comes bundled with Node.js. NPM also allows us install and manage open source plugins called `node modules`.

After cloning / downloading this project, it's important to open a terminal in the project's root directory and execute `npm install`. This command will install all dependencies required to develop or build the project and is only required once.

#### Build (Generate Static Assets)

```sh

$ npm install # Only needed the first time.

$ npm run build

```

#### Develop (Continuous Development Locally)

```sh

$ npm install # Only needed the first time.

$ npm start

```

## Template Structure

#### src/

#### dist/

#### README.md

#### package.json

#### package-lock.json

#### .gitignore

#### webpack.config.js

#### .babelrc

#### .eslintrc

#### .stylelintrc.json