Skip to content

🐲 ⚔️ 🛡 A Pathfinder Dungeons & Dragons character stat tracking web app

Notifications You must be signed in to change notification settings

cat-squad/white-tree

Repository files navigation

White Tree

Getting started

  • Be sure to have node installed (version 8 or 9 is recommended)
  • Be sure to have yarn installed (yarnpkg.com)
  • Clone this repo
  • Run yarn install to install all dependencies from package.json
  • Run yarn start to start the development environment
  • You should be good to go, the site will load on localhost:3000 by default

Libraries

Below are some libraries and best-practices I'd recommend looking into when building an app with React. (A majority of these have already been included in this project)

  • create-react-app– Create React apps with no build configuration.
  • eslint– JavaScript linting utility
  • prettier– Opinionated code formatting for js/json/css/md
  • material-ui-next– Components! Styling! More info below.
  • formik– Form state management and utilities
  • yup– Client-side form schema validation

Components + Styling with Material-UI-Next + CSS-in-JS

We'll use CSS-in-JS to help guarantee that our components have all their markup, logic, and styling, together. CSS-in-JS helps prevent against any side effects that could occur from the cascading portion of CSS, while also giving us the ability to theme and customize our components with ease.

The component library I have included in the project is Material-UI: specifically the @next version of the project (v1.0). It's currently in beta but should be released in the near future (and it's plenty stable– I am using it in production elsewhere)

All the documentation for using their components is available at https://material-ui-next.com/

Forms with Formik

The majority of functionality in applications revolve around forms. In order to maintain organization and consistency– we'll want to use the library Formik.

"My goal with Formik was to create a scalable, performant, form helper with a minimal API that does the really really annoying stuff, and leaves the rest up to you." –Jared Palmer at ReactNYC

Formik can help ensure you've accounted for the following:

  • Proper input types for requested data
  • Validation messaging at the form level
  • Validation messaging at the individual field level
  • Loading and disabled states for async data fetching and on submit

About

🐲 ⚔️ 🛡 A Pathfinder Dungeons & Dragons character stat tracking web app

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published