https://github.com/gojek/ziggurat-web

Home of all things Ziggurat.
https://github.com/gojek/ziggurat-web

gatsby gojek ziggurat

Last synced: 3 months ago
JSON representation

Home of all things Ziggurat.

• Host: GitHub
• URL: https://github.com/gojek/ziggurat-web
• Owner: gojek
• License: 0bsd
• Created: 2020-11-04T06:06:30.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-04T07:24:48.000Z (10 months ago)
• Last Synced: 2024-04-17T04:13:12.528Z (10 months ago)
• Topics: gatsby, gojek, ziggurat
• Language: JavaScript
• Homepage: https://ziggurat.dev/
• Size: 14.6 MB
• Stars: 3
• Watchers: 14
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

    

  





  Ziggurat Dev



Ziggurat Dev forms the face of GoJek's multi-stream processing framework [Ziggurat](https://github.com/gojek/ziggurat).

Ziggurat Dev aims to be a one-stop destination for your use of Ziggurat. It encompasses latest upgrades to Ziggurat, How-to docs, Case Studies and a number of things all Ziggurat. 

## 🚀 Quick start

1.  **Clone the repository**

    Clone the master branch of Ziggurat Dev to get started.

    ```shell

    # Clone the ziggurat-dev

    git clone [email protected]:gojek/ziggurat-web.git

    ```

1.  **Start developing.**

    Navigate into your new site’s directory and start it up.

    ```shell

    cd ziggurat-web/

    gatsby develop

    ```

1.  **Open the source code and start editing!**

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

    _Note: You'll also see a second link: _`http://localhost:8000/___graphql`_. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the [Gatsby tutorial](https://www.gatsbyjs.com/tutorial/part-five/#introducing-graphiql)._

    Open the `ziggurat-web` directory in your code editor of choice and edit `src/pages/index.js`. Save your changes and the browser will update in real time!

## 📝 Docs

Ziggurat dev uses Docz for rendering docs. This means you can just place a document in the `docs` folder and it automatically gets grouped and rendered. Viola!

_Feel free to use the mode change button on the top right to change into light theme, we won't judge you. Promise!_

## 🧐 What's inside?

A quick look at the top-level files and directories you'll see in this project.

    .

    ├── node_modules

    ├── src

    ├── docs

    ├── .gitignore

    ├── .prettierrc

    ├── gatsby-browser.js

    ├── gatsby-config.js

    ├── gatsby-node.js

    ├── gatsby-ssr.js

    ├── LICENSE

    ├── package-lock.json

    ├── package.json

    └── README.md

1.  **`/node_modules`**: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.

2.  **`/src`**: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. `src` is a convention for “source code”.

3.  **`/src`**: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. `src` is a convention for “source code”.

4.  **`.gitignore`**: This file tells git which files it should not track / not maintain a version history for.

5.  **`.prettierrc`**: This is a configuration file for [Prettier](https://prettier.io/). Prettier is a tool to help keep the formatting of your code consistent.

6.  **`gatsby-browser.js`**: This file is where Gatsby expects to find any usage of the [Gatsby browser APIs](https://www.gatsbyjs.com/docs/browser-apis/) (if any). These allow customization/extension of default Gatsby settings affecting the browser.

7.  **`gatsby-config.js`**: This is the main onfiguration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the [config docs](https://www.gatsbyjs.com/docs/gatsby-config/) for more detail).

8.  **`gatsby-node.js`**: This file is where Gatsby expects to find any usage of the [Gatsby Node APIs](https://www.gatsbyjs.com/docs/node-apis/) (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.

9.  **`gatsby-ssr.js`**: This file is where Gatsby expects to find any usage of the [Gatsby server-side rendering APIs](https://www.gatsbyjs.com/docs/ssr-apis/) (if any). These allow customization of default Gatsby settings affecting server-side rendering.

10.  **`LICENSE`**: This Gatsby starter is licensed under the 0BSD license. This means that you can see this file as a placeholder and replace it with your own license.

11. **`package-lock.json`** (See `package.json` below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. **(You won’t change this file directly).**

12. **`package.json`**: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project.

13. **`README.md`**: This file itself :P