Skip to content

This handbook template outlines your general approach to engineering and contains everything you need to know to start shipping code at Ghostinthewires Inc.

License

Notifications You must be signed in to change notification settings

ghostinthewires/Engineering-Handbook

Repository files navigation

Engineering Handbook Template 🔥

🔥 - A Blazing Fast, OpenSource Engineering Handbook Template for Engineering Teams who want to go further, faster 🚀

Features

  • Easy to Setup 💯

  • Free to Use ( OpenSource ) 🥳

  • Fully Responsive 🚀

  • Super Fast and Optimized for SEO ⚡

  • Great Audits Score 🎖️

Lighthouse Score

Technologies used 🛠️

  • HTML 🚀
  • CSS 🚀
  • JavaScript 🚀
  • Jekyll 🚀

Deployment 📦

I highly recommend using GitHub pages [FREE].

The main branch is built using Jekyll on each commit and automatically deployed by GitHub and displayed at the DEMO LINK (You can also CNAME this to your own domain, like we do at here

Build & run locally 🔧

Assuming you are on Windows, first install Ruby+Devkit 2.7.X (x64)

Currently GitHub Pages does not support Ruby 3.X.X so we do not recommend using this locally. (However, if you did, you would also need to run "bundle add webrick" as per issue)

# Clone this repository
git clone https://github.com/ghostinthewires/Engineering-Handbook.git

# Go into the repository
cd Engineering-Handbook

# Build & serve
bundle install
bundle exec jekyll serve

Now browse to http://127.0.0.1:4000

Give a Star ⭐

If you like this project then give it a Github star by pressing the Star button ⭐

Author 👨‍💻

Feel free to follow me on Twitter

License 📄

This project is licensed under the MIT License - see the LICENSE file for details

About

This handbook template outlines your general approach to engineering and contains everything you need to know to start shipping code at Ghostinthewires Inc.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published