My website & blog based on Gatsby.js
As this website/blog is based on Gatsby.js it heavily relies on Javascript and React. To get it running locally you need Node and npm or yarn installed.
As I use yarn it would be best for you to use yarn as well. This repo comes with an own yarn version to reduce inconsistencies between different yarn-versions (for more information see Yarn determinism). To get this working deterministicly you need at least yarn version 1.0.
Nonetheless after cloning the Repository the first thing you should run is:
yarn global add gatsby-cli # npm install --global gatsby-cli
yarn # npm installThis should install all required dependencies. After that you can run:
gatsby developThis should start a hot-reloading development environment accessible at localhost:8000
Form there on you are good to go to make changes on the website. See the Gatsby documentation for more information on that.
To ensure a consistent codestyle & formatting this project relies on prettier as well as eslint. Both gets setup when you run yarn # npm install in the setup stage.
To check for linting & formatting errors in your code simply run yarn test:lint # npm run test:lint. You can also automatically fix every linting error with yarn test:lint:fix # npm run test:lint:fix. Same goes for formatting with yarn format # npm run format.
You can also check for typesafety with flow. To run it simply run yarn test:typecheck # npm run test:typecheck. This will check all files marked with a flowmarker. You could also run yarn test:typecheck:all # npm run test:typecheck:all to run it on all files.
In the end if you want to check for lint, formatting errors and typeerrors you can simply execute yarn test # npm run test to run all mentioned checks.
After developing and checking your changes you can build it with:
gatsby buildAdditionaly you can check the final result with:
gatsby serveTo get the Page online for others to see, look at the Gatsby documentation