Giter Site home page Giter Site logo

zmilan / gatsby-themes Goto Github PK

View Code? Open in Web Editor NEW

This project forked from lekoarts/gatsby-themes

0.0 1.0 0.0 5.68 MB

Get high-quality and customizable Gatsby themes to quickly bootstrap your website! Choose from many professionally created and impressive designs with a wide variety of features and customization options.

Home Page: https://themes.lekoarts.de

License: MIT License

JavaScript 85.24% TypeScript 14.65% HTML 0.01% Shell 0.10%

gatsby-themes's Introduction

LekoArts

Free & Open Source Gatsby Themes by LekoArts

@lekoarts/gatsby-themes is released under the MIT license. CircleCI Status PRs welcome! Follow @lekoarts_de

Get high-quality and customizable Gatsby themes to quickly bootstrap your website! Choose from many professionally created and impressive designs with a wide variety of features and customization options. Use Gatsby Themes to take your project to the next level and let you and your customers take advantage of the many benefits Gatsby has to offer.

๐Ÿ’ผ Contents

This repository is a collection of my Gatsby themes, managed as a monorepo with Lerna and yarn workspaces.

  • examples: Contains the corresponding example sites for the themes. These projects can and should be used as a starter and will be copied over to their own repository. Hence they contain example data and additional Gatsby plugins (e.g. gatsby-plugin-manifest and gatsby-plugin-offline). The folder names are the contents after gatsby-theme-*
  • themes: Contains the themes themselves. They should only have the bare minimum of plugins installed (as examples can expand them) and also use Theme UI for styling. The naming of the folders must be gatsby-theme-[name-with-dashes] and the package name under the scope of @lekoarts
  • www: Contains the source code for themes.lekoarts.de

๐Ÿค How to Contribute

Make sure that you have yarn installed on your machine (as it's mandatory for yarn workspaces). Fork this repository, clone it and run yarn in the root directory.

To launch the development server of an example site, use:

yarn workspace [examples/name] develop

In the case of examples/emma this command would be yarn workspace emma develop. Now you can make changes to the respective theme and see them via Hot-Reloading.

Commit your changes to a feature branch of your fork and open up a PR against this repository. The PR will have checks in place (unit and end-to-end tests) which you can also run on your machine in preparation for the PR.

Testing

Cypress

The Cypress tests are written in TypeScript, too, and hence need to be compiled before usage. Run the following script for development:

bash ./scripts/e2e-dev.sh "example-name"

In the case of examples/emma the "example-name" would be "emma".

The script starts tsc in watch mode (for the files in cypress/e2e) and outputs them to cypress/e2e/build + starts start-server-and-test with Gatsby's development server and Cypress. Once the Cypress GUI opens select the fitting test (the others won't work, only the respective test + smoke.js!).

CircleCI will run the e2e-build.sh script โ€” you can use it to run the tests headless.

You can skip the e2e tests if you use docs or www in your branch name, e.g. docs/improve-readme or www/add-new-entry.

๐Ÿคฉ Newsletter

If you want to receive monthly updates on my themes and all things related to Gatsby themes (relevant blog posts from me and other people) you can subscribe to my newsletter.

๐ŸŽ“ Learning Gatsby Themes

gatsby-themes's People

Contributors

lekoarts avatar renovate[bot] avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.