Skip to content

Statically generated marketing site for TeachWV – an initiative from the WV Department of Education

License

Notifications You must be signed in to change notification settings

wveducation/teachwv

Repository files navigation

TeachWV.com

This site aims to help prospective educators learn more about the many ways to become a teacher in West Virginia.

Live Site

TeachWV

Technologies used:

  • Eleventy - a static site generator.
  • Alpine.js - lightweight JS library for simple interactions (no need for jQuery!)
  • Tailwind CSS - rapid utility-first CSS framework.
  • Netlify CMS * development only - A local backend for your data entry needs (so you don't have to write markdown files directly for Eleventy).

Deploy to Netlify


Getting Started

1. Clone this Repository

git clone https://github.com/wveducation/teachwv.git

2. Navigate to the directory

cd [project_root]

3. Install dependencies

npm install

4. Build the project to generate the first CSS

This step is only required the very first time.

npm run build

5. Run Eleventy

npm run start

Local Netlify CMS

If you'd like to log into the Netlify CMS locally (/admin), you'll need to run this proxy server. You'll be able to bypass the "Login with Netlify Identity" screen this way.

npx netlify-cms-proxy-server

You may find that if your site isn't running on the default port (8081), you'll need to make a configuration change.


Web Performance

This tech stack significantly lowers the cost of achieving high levels of web performance. We've consistently accomplished a perfect 400 in Google Lighthouse Audits and aim to keep it that way.

alt="Perfect Google Lighthouse Score"


Hosting

This site is hosted using Github Pages.

Why? Because procuring hosting quickly can be very onerous in state government. We'd prefer to host using Netlify's services, enabling the use of the Netlify CMS in the live environment, but purchasing officers can't readily accept their Terms of Service in WV. 🥴

This site is deployed to Github Pages through a Github Action (look here) on every commit to master.


Who Made This?

Aaron Silber, Design, Development at WV Department of Education

Shaun Dover, Development at WV Department of Education

Kristina Hawley, Graphic Design at WV Department of Education

Megan Archer, Content Creation at WV Department of Education