README.md

Self Improvement Project

"It might be exactly what you need to hear today" - Lawrence McLelland

Contributors

Tech Stack

• React
• Redux
• Material-UI
• Bootstrap
• Github Pages

Directories

• docs public facing webpage rendered by Github Pages
• public holds favicon & base html file
• src all the Typescript React code
  • artciles articles in Markdown
  • components parts of the website written in React
  • redux state management for handling cached data
  • resources images
  • styles css styling of html
  • tests tests to test the React components
  • utils common utility methods

Prerequisites

• Install nvm
• Install yarn

Installation

• Use correct version of node with: nvm use
• Install node dependencies with: yarn install

Development

• Run the webpage locally with: yarn run
• Make changes you want to see

Deploying

• Ensure to build webpage with: yarn build
• Commit to main branch
• Github Pages will auto deploy the updated webpage