Git Product home page Git Product logo

gatsby-reverb's Introduction

creating-source-plugin-tutorial

Companion project for the Creating a Source Plugin Gatsby tutorial.

Prerequisites

You'll need to have these tools installed:

  • Node.js (v18 or newer)
  • Git
  • Yarn

You can also follow Part 0: Set Up Your Development Environment for more detailed instructions.

Usage

  1. Clone this project
  2. yarn to install dependencies
  3. yarn test to run unit tests
  4. yarn lint:fix to run linting

Development

  1. yarn develop:deps to build & serve the API at http://localhost:4000, and to also watch the source plugin for changes
  2. yarn develop:site in another terminal window to run gatsby develop for the test site

If you make changes to the source plugin you will need to restart the site server to see the changes reflected in the site.

Build

  1. yarn start:api to build and serve the API at http://localhost:4000
  2. yarn build in another terminal window to build the production plugin and site
  3. yarn serve:site to serve the Gatsby site at http://localhost:9000. You should see an overview of all posts

Project structure

This project includes three directories:

  • api is the example mock backend API you will source from
  • plugin is the example source plugin
  • site is the example site

The source plugin consumes the API, and the site uses the source plugin.

gatsby-reverb's People

Contributors

lekoarts 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.