This page is a work in progress.You can help improve it. →

Missing Document Title

theme: Next, 1

Generating Your Own Front-End Project Template


[fit] Do we even need a template or tools?

[.autoscale: true ]

  • For HTML/CSS projects we don't really need any tools at all.

  • We could just have a .html and a .css file in a directory and open the file itself in our browser.

  • Tools give us:

    • Code reloading
    • Optimization
    • Ability to easily add third party code (CSS frameworks, CSS resets, etc.)
    • Automation steps

[.autoscale: true ]

[fit] app-app is dead, long live app-app

For many cohorts, SDG used app-app a JavaScript based tool that created template-based projects for students.

[.column]

Benefits:

  • Curated environments with just the right tools
  • Automatically created a git project and sent code to github
  • Built in steps for deploying

[.column]

Downsides:

  • Not an "industry wide tool"
  • SDG has to upkeep the app as tools and libraries change versions

[.autoscale: true ]

[fit] Our new approach

Use industry "standard" front-end code bundlers.

[.column]

Benefits:

  • Tools are kept up to date
  • Faster and easier to install
  • Industry "standard"

[.column]

Downsides:

  • New tools created every day (not literally, but very close)
  • Requires more effort to get setup
  • Less automation for steps like creating git setup and github repository

[fit] Tool of choice: vite

  • Fast
  • Built on latest tools
  • Supports all our technologies out of the box
  • Easy to customize

See: vite's homepage


[.autoscale: true]

[fit] Getting started - SHORTCUT MODE

To skip the rest of this setup and simply duplicate what SDG already setup:

cd ~/sdg
degit suncoast-devs/html-css-ts-project-template
cd html-css-ts-project-template
git init
git add .
git commit -m "Initial commit"
hub create
git push origin HEAD

And you will have your own copy of SDG's project template.


[fit] Getting started

In the same directory where you create projects:

npm init vite -- html-css-ts-project-template
  • Choose vanilla as the framework
  • Choose vainlla-ts as the variant

[fit] Check out the template it created

cd html-css-ts-project-template
npm install
git init
git add .
git commit -m "Initial vite template"
code .

Project Structure

fit inline


[fit] Review files

FilePurpose
index.htmlMain HTML content
favicon.svg"favicon" graphic uses as the website icon
package.jsonProject definition file where we list configuration and code dependencies
package-lock.jsonRecords the specific version of dependencies this project uses
tsconfig.jsonConfiguration file for TypeScript (see later)
.gitignoreConfiguration for git to ignore files that do not belong in our project history
src/main.tsPlace to put our TypeScript code when we write some - And a file that loads our CSS content
src/style.cssOur CSS
src/vite-env.d.tsConfiguration for Vite itself

[fit] Customize!


index.html

  • Change the default <title>
  • Remove <div id="app"></div>
  • Add any default HTML you think you'll want in EVERY template to start. Perhaps a <p>Hello, World</p> so something is on screen.

favicon.svg

Suggest SDG's badge graphic available here

inline left


src/main.ts

Remove all the lines except for the following:

import './style.css'

src/style.css

Use the following starter CSS:

:root {
font: 16px / 1 sans-serif;
}
html {
height: 100%;
}
body {
margin: 0;
min-height: 100%;
}

package.json

[fit] Individual changes (example file on the next slide)

[.column] Update the scripts section to include:

"start": "vite",
"predeploy": "npm run build",
"deploy": "netlify deploy --prod --dir=dist",

[.column] Add this section:

"prettier": {
"trailingComma": "es5",
"tabWidth": 2,
"semi": false,
"singleQuote": true,
"useTabs": false
}

package.json

{
"version": "0.0.0",
"scripts": {
"start": "vite",
"predeploy": "npm run build",
"deploy": "netlify deploy --prod --dir=dist",
"dev": "vite",
"build": "tsc && vite build",
"serve": "vite preview"
},
"devDependencies": {
"typescript": "^4.3.2",
"vite": "^2.4.2"
},
"prettier": {
"trailingComma": "es5",
"tabWidth": 2,
"semi": false,
"singleQuote": true,
"useTabs": false
}
}

[fit] Ensure the latest version of vite and typescript

npm install --save-dev vite typescript

[.autoscale: true]

[fit] Turn on TypeScript checking in our terminal

npm install --save-dev vite-plugin-checker

Create the file vite.config.ts with the following:

import { defineConfig } from 'vite'
import checker from 'vite-plugin-checker'
// https://vitejs.dev/config/
export default defineConfig({
plugins: [checker({ typescript: true })],
})

[fit] Capture initial version of our customized template

git add .
git commit -m "Initial template customization"

[fit] Create a github repository for the project

hub create
git push origin HEAD

Congratulations

You have just created your own initial starter project for the HTML and CSS projects we'll be doing in this course.

You can return to this repository and make any changes you'd like to become your new default template.

Perhaps you'll develop a color palette you like to use in each project. Come back to this template and add that CSS. All new projects you create will have that CSS.


More templates!

When we start with TypeScript we will use the same template.

We'll create a separate template when we start with React


Using your template

cd ~/sdg
degit YOUR-GITHUB-GOES-HERE-DONT-TYPE-THIS/html-css-ts-project-template FirstSampleProject

(e.g.)

cd ~/sdg
degit jane-doe/html-css-ts-project-template FirstSampleProject FirstSampleProject
cd

This will make a new, clean, empty, NON GIT, repository

Make this a git repository

cd FirstSampleProject
git init

Make a first initial commit to capture the base template

git add .
git commit -m "Initial commit"

Turn this into a GitHub project

hub create

Push our first commit to GitHub

git push origin HEAD

All together now...

degit YOUR-GITHUB-GOES-HERE-DONT-TYPE-THIS/html-css-ts-project-template FirstSampleProject
cd FirstSampleProject
npm install
git init
git add .
git commit -m "Initial commit"
hub create
git push origin HEAD

Running the project!

We will use npm start to run the project itself. This is similar to npm watch run from C#

npm start

Open the browser

The terminal will give you the URL where the application is running, typically http://localhost:3000

Open that URL in your browser.


Update some code

You should see the browser automatically refresh!


© 2017 - 2021; Built with ♥ in St. Petersburg, Florida.