Skip to content

Instantly share code, notes, and snippets.

@reymon359
Last active May 6, 2021 05:31
Show Gist options
  • Save reymon359/a0880e5b3bfcbac54f58b52b3ade2e02 to your computer and use it in GitHub Desktop.
Save reymon359/a0880e5b3bfcbac54f58b52b3ade2e02 to your computer and use it in GitHub Desktop.
README.md teamplate

gatsby-personal-site

Gatsby Personal Site

Build Last commit License: MIT Version

A personal site made with the static site generator Gatsby

site screenshot

This site is meant to be a place to add and share my works about the things I learn and what I'm interested in. It was built from the Gatsby's default starter

Built With these Technologies

  • Gatsby: React-based open source framework for creating websites and apps.
  • React: Javascript library for building User Interfaces.
  • TypeScript: Microsoft's open-source Type-safe language that compiles to JavaScript.
  • Styled-Components: CSS in JS Library for the styles.
  • GraphQL: The query language used to access the data with Gatsby.
  • Commitlint: To enforce conventional commit format.
  • GitHub Actions: GitHub's Continuous Integration & Delivery tool.
  • Renovate: Free, open-source app to automate the update of dependencies.

Setup the project

Download it and run npm install

Available Scripts

In the project directory, you can run:

npm run start

Runs the app in the development mode.
Open http://localhost:8000 to view it in the browser.

npm run format

formats document files according to the rules of the .prettierrc file.
See more information about prettier configuration here.

npm run build

Builds the app for production. The build is minified and the filenames include the hashes.
The app is ready to be deployed!

npm run deploy

Builds the app for production and deploys it to GitHub Pages
Have a look at How Gatsby Works with GitHub Pagesw to configure it.

npm run lint & npm run lint:fix

Run ESLint on the project to report wrong patterns on the code, and the second one also tries to fix them

Authors

Credits

This README.md file was generated from an open source template. Have a look at it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment