tojeiro-me / Plasttic

Plasttic Web Workflow: A methodology based Front-End development environment for Static Sites

Home Page:https://plasttic.dev

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Plasttic

Plasttic Web Workflow

A methodology based Front-End development environment.

npmnpmLICENSEVOLTATwitter Follow


About


Plasttic Web Workflow is a methodology based professional Front-End development environment for Websites and Web Apps: HTML and CSS/PostCSS boilerplate, Atomic Design System, Javascript/Typescript, Dev/Build Scripts, File structure, Conventions & Best Practices.

This workflow is not intended to be a framework, but rather a starting point, allowing the developer to implement a methodology that produces accessible, scalable and robust interfaces.

Related projects:



Methodology


  • Core Fundamentals
  • Best Practices/Conventions
  • Performance/Core Web Vitals
  • Documentation
  • Accessibility/Semantic HTML
  • Design System/Atomic Design
  • BEM Methodology
  • CSS Reset
  • SEO/Social Media Boilerplate
  • Code Conventions/Linting
  • Debug/Test

Start


Quick Start:

(cd into your projects folder)
npx create-plasttic
cd project-name
npm install
  1. Creates a folder with the project name you defined
  2. Downloads and installs the latest version of Plasttic Web Workflow
  3. Installs all the project dependencies

Workflow

Development

  • Run npm run dev to start the dev server on http://localhost:8000 *

  • Run npm run build when you are ready to publish *

  • *Source folder: src/, Dev folder: dev/, Build folder: dist/

Customize:

  • Search for "TODO:" in comments, relative to info that needs to be changed or checked. After, change it to "DONE:". If using VS Code, use the Todo Tree extension or TODO Highlight
  • If .##gitignore## exists, rename it to .gitignore and customize to your project info.

Development with https:

  • Step 1: Run mkdir certs
  • Step 2: Run cd certs
  • Step 3: Install certificate with mkcert
  • Step 4: Check certificate filenames and/or path in the file browser-sync.cjs
  • Step 5: Run npm run dev:ssl to start the dev server on https://localhost:8000

Manual Install (Clone):

  • Step 1: Copy the repository git clone https://github.com/tojeiro-me/Plasttic.git (The project files are inside the packagefolder)

  • Step 2: Move the the contents of the package folder into your project-folder

  • Step 3: Run cd project-folder-name

  • Step 4: Rename .##gitignore## to .gitignore

  • Step 5: Run npm install to install the needed dependencies

  • Step 6: Run npm run dev to start the dev server on http://localhost:8000 *

  • Step 7: Run npm run build when you are ready to publish *

  • *Source folder: src/, Dev folder: dev/, Build folder: dist/

Templates


Documentation


  • File Comments
  • Check docs folder 🚧
  • Documentation website (Soon!)

Please check the CHANGELOG for major or breaking changes

Links


  • Website 🚧
  • Documentation (Soon!)

Follow


TwitterMastodonGithub


License



Plasttic

About

Plasttic Web Workflow: A methodology based Front-End development environment for Static Sites

https://plasttic.dev

License:MIT License


Languages

Language:JavaScript 81.1%Language:CSS 6.5%Language:TypeScript 6.4%Language:HTML 5.9%Language:Shell 0.0%