Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 2.97 KB

README.md

File metadata and controls

54 lines (37 loc) · 2.97 KB
Raw

Personal Website

CI workflow MIT licence Production deployment Documentation deployment Website status UptimeRobot Mozilla HTTP Observatory Known Vulnerabilities code style: prettier Commitizen friendly

See the live site at vendittelli.co.uk

My personal website. An MIT licensed, React application that deploys automatically using Terraform. Built using TypeScript, based on the Nx build system with SCSS, GitHub actions, and many other useful technologies.

Dependencies

The project is rested with node >= v18 and Yarn 1.

See dependencies.md for more information.

Set up

To download the repository and install dependencies, run the following commands:

git clone https://github.com/SVendittelli/vendittelli.co.uk.git
cd vendittelli.co.uk
yarn install

or, if you have the GitHub CLI, run:

gh repo clone SVendittelli/vendittelli.co.uk
cd vendittelli.co.uk
yarn install

Running locally

Run the following command to build the home application and serve it with fast refresh:

yarn start

Documentation

See the live docs at docs.vendittelli.co.uk

The project's documentation is deployed using GitHub pages from the docs folder.