Skip to content

Latest commit

 

History

History
37 lines (19 loc) · 2.07 KB

README.md

File metadata and controls

37 lines (19 loc) · 2.07 KB

TJI Next JS Website

To get started clone this repo and cd to the directory, then run:

npm install

To start the dev server run:

npm run dev

The url for the dev server will be: http://localhost:3333/

Javascript Style Guide

To maintain consistency in code formatting and to avoid a ton of problems with Github tracking changes that are just differences in tab width, etc., this repo is set up according to Wes Bos's No-Sweat™ Eslint and Prettier Setup

The Local/Per Project Install is taken care of when you run yarn or npm install. Please follow the With VS Code instructions (if you're using VS Code) to have the formatting applied on save.

Proptype Validation

We are using prop-types for component property validation. When building or updating components that have property, validation should now be incorporated as well.

See the documentation for more information.

Netlify CMS

Some content is editable with Netlify CMS. Editors log in to the CMS at https://texasjusticeinitiative.org/static/admin. When an editor saves content changes, the CMS opens a pull request to save the content as Markdown in /content. We compile the Markdown into the HTML on the live site. The content available to edit in the CMS is configured in /static/admin/config.yml. Learn more in the Netlify CMS docs.

Resources

Next JS Docs

Next JS Tuturials

A 5-minute Intro to Styled Components

styled-components website