create-evergreen-app

create-evergreen-app

Overview

A starter project for getting up and running with an evergreen web application development stack designed by, and for, today's modern web.

Project Goals

The goal of Project Evergreen is to march alongside the modern web and bring that to this repo so that both developers and users can benefit. Evergreen Web Applications aim to be performant, promote usage of modern web features, be accessible to a wide range of users, and be a productive experience for developers.

Acknowledgements

This project is made by possible with the much appreciated existence of tools like:

• webpack v4
• LitElement
• Babel v7 / PostCSS
• Browserslist
• WebComponents.org

And of course, nods and kudos go out to the maintainers of Create React App (CRA) and Pascal Shlip (@thepassle) of Create Lit App for the inspiration.

Thank you, to all of you!

Under Development

This repo and Project Evergreen itself are still young and maturing rapidly. The Project Evergreen GitHub organization project tracker captures the high level goals and next steps, with plans to keep adding those lessons learned as features and improvements to this repo.

Immediate needs for this repo are:

• Routing
• Route based code spliting + Lazy Loading
• Opt-in IE11 Support

🙏 Please feel free to contribute, we are always looking forward to meeting like minded developers to collaborate with!

Getting Started

Installer assumes you have git on your system

Make sure you have Node.js 8.x installed and then follow these steps to get up and running:

# 1) create a new evergreen app
$ npx create-evergreen-app my-app
$ cd my-app

# 2) install dependencies
$ npm install

# or 

$ yarn install

# 3) Start developing!
$ npm start 

# or 

$ yarn start

📖 For more documentation and developer guides that cover topics like the build process, browser and device support, creating components, and more, please check out our wiki!

Usage

To start developing, you can simply go ahead and edit and add files as you need in src/.

ℹ️ Feel free to edit or delete any content / code related to Create Evergreen App (including README.md) to customize this repo to your own needs.

Development

Automated tasks have been made available as npm scripts that you can run from the command line using yarn or npm run:

• develop - To start a development server with live reload and file watching
• build - Generate a production build of the app for deployment
• serve - Locally serve a production build
• test - Run unit tests in TDD mode (prepend with NODE_ENV=production for "single run" usage)
• start - alias to the develop task

e.g. to start developing, run

# yarn
$ yarn develop

or

# npm
$ npm run develop

Package Management

Your team may choose to use either npm or Yarn, just make sure to pick one and remove the other manager's lock file. Make sure to update the lock file whenever adding / removing a package.

Guides

These are some guides related to configuring different parts of this application to customize it for your needs.

Folder Structure

There is no right or wrong folder structure per se as with most decisions relating to technology, it's about finding the best tool for the job. Pick the conventions that fit your team / project best.

That said, CEA does come with with a lightly opinionated structure in the src/ directory as one of the main goals of a good folder structure should be to assist in the finding of files / code faster and being predicatable. Here is some info on the approach presented / suggested in this repo:

• index.js - Main Entry point into the application (defined in webpack.config.common.js)
• index.html - Defines the HTML "shell" of the application.
• app/ - The top level "app" component, that will be used to bootstrap the application.
• components/ - Essentially all the custom elements for an app will go here, encapsulating all reusable UI logic.
• pages/ - Routable states and / or views that users will navigate to within an application.
• services/ - Utilities for making (RESTful) API calls, convenience "wrappers" around browser APIs (Web Storage), etc. These generally don't interact with the DOM (that's what components are for).

Unit tests are recommended to be kept side by side with the component / class / etc. For integration and E2E tests, consider making a test/ directory alongside the src/ directory and put those tests there.

Setting Up (API) Proxies

In webpack.config.develop.js and lws.config.js are sections for setting up proxies for routing requests, say to an API running in your development envrionment. Edit the placeholders to match your particular needs.

CSS + Shadow DOM

// TODO

Performance

Performance is an important consideration for developing and maintaing any modern web application. Out of the box, this project uses webpack's default settings for performance budgets and will error when its thresholds are exceeded.

The goal of this project will be to support good code splitting and lazy loading strategies by default to allow apps to scale horizontally as more pages / features / dependencies get added.

To learn more about performance best practices for modern web application development, check out the wiki.