Skip to content

Chronstruct/static-starter

Folders and files

NameName
Last commit message
Last commit date
Jan 11, 2018
Jan 11, 2018
Jan 11, 2018
Apr 27, 2020
Nov 12, 2019
Sep 6, 2018
Sep 6, 2018
Jan 11, 2018
Sep 6, 2018
Jan 11, 2018
Apr 27, 2020
Nov 12, 2019
Apr 27, 2020
Jan 11, 2018
Apr 27, 2020

Repository files navigation

Chronstruct's Static Starter Site

A starter repo for a static site to be hosted on something like S3, Github Pages, or Netlify

Up and Running

$ git clone git@github.com:Chronstruct/static-starter.git <YOUR_REPO_NAME>
$ cd <YOUR_REPO_NAME>
$ git remote set-url origin <YOUR_NEWLY_CREATED_GIT_REPO_URL>
$ git remote add upstream git@github.com:Chronstruct/static-starter.git #for merging future updates
$ npm install
$ npm start
$ open http://localhost:8080

Features

Render to html for fast initial page loads, then use react-router for SPA transitions

Hotloader for development

normalize.css and box-model reset

Still to be added...

Dev notes

Please consult the React Playbook for style, layout, architecture, and rules

Directory Layout

.
├── /assets
│   ├── /fonts/
│   ├── /images/
│   └── /videos/
|
├── /src                       # Your site-specific source code of the application
│   ├── /scenes/                # Components that are handled by a Navigator. Same as pages, views, etc for the app.
│   |   ├── /App/               # Root scene
│   ├── /shared/                
│   |   ├── /components/        # Shared components used in 2+ scenes
│   |   ├── /logic/             # **Optional** Util/Helper js functions that are app and/or model aware
│   ├── /stores/                # **Optional** Responsible for you app state. Houses MobX actions and observables
│   └── /entry.js               # Entry point for static-site-generator and client-side react-router
|
├── /lib                        # Your non-site-specific Components and functions
|
├── /node_modules/              # 3rd-party libraries and utilities
└── package.json                # The list of 3rd party libraries and utilities

Run targets

  • npm run clean - Delete the generated public/ folder
  • npm run reinstall - Delete node_modules, then install them again
  • npm run build - Generate static files in public/ for dev
  • npm run build:dev - Generate static files in public/ for dev
  • npm run build:prod - Generate static files in public/ for production (minified)
  • npm run server:dev - Start webpack-dev-server with hotloader enabled for hosting public/
  • npm run server:prod - Host public/ as a production server would
  • npm run dev - build:dev then server:dev
  • npm run prod - build:prod then server:prod
  • npm start - run dev
  • npm deploy - use gh-pages deploy public/ to Github Pages

Updating repo with Starter-Static-Site changes after forking it

$ git fetch upstream
$ git checkout master
$ git merge upstream/master

Recommended libs for taking this further

Again, consult the Playbook

Useful resources

Support

Tweet @kylpo

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published