Skip to content

Show the live statuses of your Netlify and CircleCI builds on your website! Easily integrate the customizable components into your site and adapt them to your theme (utilizing Theme UI).

License

LekoArts/gatsby-status-dashboard

Repository files navigation

LekoArts

Gatsby Status Dashboard

Gatsby Status Dashboard is released under the 0BSD license. GitHub Sponsors Website Follow @lekoarts_de

Showing the statuses of Netlify deploys & CircleCI projects. Using the Gatsby Theme @lekoarts/gatsby-theme-status-dashboard. Made with gatsby-source-netlify and gatsby-source-circleci.

Demo Website

Also be sure to check out other Free & Open Source Gatsby Themes and my Personal Website.

⏱️ Quick Start

Deploy this starter with one click on Netlify:

Deploy to Netlify

🚀 Getting Started

1. Create a Gatsby site.

Use the Gatsby CLI to clone the site and install dependencies:

npx gatsby new gatsby-status-dashboard https://github.com/LekoArts/gatsby-status-dashboard

2. Navigate to your new project.

cd gatsby-status-dashboard

3. Open the code and start customizing!

Start the site by running npm run develop.

Your site is now running at http://localhost:8000!

If you want to learn more about how you can use a Gatsby starter that is configured with a Gatsby theme, you can check out this shorter or longer tutorial. The tutorials don't exactly apply to this starter however the concepts are the same.

📝 Using and modifying this starter

Important Note: Please read the guide Shadowing in Gatsby Themes to understand how to customize the underlying theme!

This starter creates a new Gatsby site that installs and configures the theme @lekoarts/gatsby-theme-status-dashboard.

Have a look at the theme's README and files to see what options are available and how you can shadow the various components including Theme UI. Generally speaking you will want to place your files into src/@lekoarts/gatsby-theme-status-dashboard/ to shadow/override files. The Theme UI config can be configured by shadowing its files in src/gatsby-plugin-theme-ui/.

Change your static / assets folder

The static & assets folders contain the icons, social media images and robots.txt. Don't forget to change these files, too! You can use Real Favicon Generator to generate the image files inside static.

🤔 Questions or problems?

If you have general questions or need help with Gatsby, please go to one of the support platforms mentioned in Gatsby's documentation. If you have a specific question about this project, you can head to the GitHub Discussions of the repository.

🎓 Learning Gatsby

Looking for more guidance? Full documentation for Gatsby lives on Gatsby's website.

Themes

To learn more about Gatsby themes specifically, I recommend checking out the theme docs.

General

🌟 Supporting me

Thanks for using this project! I'm always interested in seeing what people do with my projects, so don't hesitate to tag me on Twitter and share the project with me.

Please star this project, share it on Social Media or consider supporting me on GitHub Sponsors!

About

Show the live statuses of your Netlify and CircleCI builds on your website! Easily integrate the customizable components into your site and adapt them to your theme (utilizing Theme UI).

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published