https://github.com/fiftin/siteboilerplate

Static website boilerplate
https://github.com/fiftin/siteboilerplate

boilerplate boilerplate-template pug-templates static-site static-site-generator static-website

Last synced: 17 days ago
JSON representation

Static website boilerplate

• Host: GitHub
• URL: https://github.com/fiftin/siteboilerplate
• Owner: fiftin
• License: mit
• Created: 2020-11-12T20:02:31.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-29T08:13:31.000Z (5 months ago)
• Last Synced: 2024-06-29T09:26:58.383Z (5 months ago)
• Topics: boilerplate, boilerplate-template, pug-templates, static-site, static-site-generator, static-website
• Language: Pug
• Homepage:
• Size: 2.1 MB
• Stars: 15
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## What is it?

SiteBuilderplate is a start point for creating a static S3-hosted website. It has a modern stack:

| Technology             | Responsibility  |

|------------------------|-----------------|

| NPM with Gulp          | Build           |

| Ansible                | Deploy          |

| Terraform              | Cloud resources |

| Pug                    | Pages           |

| SCSS                   | Design          |

| Bulma                  | UI Framework    |

| Visual Studio Core     | Code writing    |

| Component architecture | Code quality    |

### Requirements

* AWS account

* macOS or Linux (Windows is not supported)

* Ansible 2.9+

* Node.js 14.15.0+

* Visual Studio Code with plugins:

    * Live Server ([ritwickdey.liveserver](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer))

    * File Watcher ([appulate.filewatcher](https://marketplace.visualstudio.com/items?itemName=appulate.filewatcher))

### 1. Test

Build the project

    npm run build

Run Live Server

![](/src/templates/how-to-go-live.png)

### 2. Setup

_NOT IMPLEMENTED!!!_

    npm run setup example

### 3. Deploy

Deploy website to AWS

    npm run deploy example

### 4. Destroy

_NOT IMPLEMENTED!!!_

    npm run destroy example

### How setup should works

_NOT IMPLEMENTED!!! you should do it manually_

1. Ask the user to the AWS access key. (required)

2. Ask the user to the AWS access secret (required)

3. Ask the user to a domain name (optional)

    With using Terraform:

    * Create S3 bucket

    * Create Lambda@Edge

    * Requst SSL Certificate (if domain name provided)

    * Create CloudFront distribution

4. Ask the user to add a CNAME record to confirm domain owning (if domain name provided)

5. Waiting domain confirmation (if domain name provided)

6. Setup successfully finished

7. Destroy all resources if the user canceled setup

### Recomendations

Use Cloudflare to protect your website from DDoS attacks.

Create a fork to start using the boilerplate.