sizovs / nikoheikkila.fi

A blog by Niko Heikkilä. Powered by coffee, VS Code, and Gatsby.

Home Page:https://nikoheikkila.fi

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Welcome to nikoheikkila.fi 👋

Netlify Status Build Status Codacy Badge

My personal blog. Forked from Gatsby Blog Starter template and inspired here and there by Dan Abramov's blog.

🔧 Installation & Usage

Environment

Gatsby makes use of several environment variables which are documented in .env.example file. Before building the project make sure to modify these variables as needed. Then copy the .env.example as .env.development to project root for Gatsby to recognize it.

1. Build Locally with Yarn

To run the build locally, type like so:

cp .env.example .env.development
yarn
yarn dev

2. Build Locally with Netlify

Alternatively, you can mimic the production environment from Netlify like so:

npm install -g netlify-cli
ntl dev

This will download and execute a Netlify builder running the gatsby develop command.

Finally, open http://localhost:8000 to view the blog.

🤖 Run tests

Project is packaged with Prettier formatter, AVA unit tests, Playwright automated tests, and Pa11y accessibility tests. They can be ran respectively like so:

yarn lint
yarn test:unit
yarn test:dev
yarn test:a11y

👤 Author

Niko Heikkilä <yo@nikoheikkila.fi>

🤝 Contributing

Content can be found under content/ directory. Edit posts as needed and submit a PR for me to review. All PRs are automatically deployed by Netlify as preview deployments. Once approved and merged to master branch they will be deployed to production.

Other contributions to UI, accessibility, React components, security, dependency updates etc. are warmly welcome as well!

Feel free to check the open issues.

✍️ Writing

To quickly bootstrap a new post or page draft use the CLI tool new.js at project root either via yarn new or invoking directly.

📝 License

Copyright of blog posts © 2019 Niko Heikkilä <yo@nikoheikkila.fi>.

Source code of this project is MIT licensed.


This README was generated with ❤️ by readme-md-generator.

About

A blog by Niko Heikkilä. Powered by coffee, VS Code, and Gatsby.

https://nikoheikkila.fi

License:Other


Languages

Language:TypeScript 69.0%Language:JavaScript 16.6%Language:SCSS 13.0%Language:Dockerfile 1.0%Language:Shell 0.4%