Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kentico/kentico.github.io

The code behind the kentico.github.io website.
https://github.com/kentico/kentico.github.io

community developers gatsbyjs kentico kentico-cms kentico-ems kentico-kontent site

Last synced: about 17 hours ago
JSON representation

The code behind the kentico.github.io website.

Awesome Lists containing this project

README

        

# Kentico GitHub Community site

[![Build & Deploy](https://github.com/Kentico/kentico.github.io/actions/workflows/integrate.yml/badge.svg)](https://github.com/Kentico/kentico.github.io/actions/workflows/integrate.yml)
[![Live](https://img.shields.io/badge/live-demo-brightgreen.svg)](https://kentico.github.io)
[![Stack Overflow](https://img.shields.io/badge/Stack%20Overflow-ASK%20NOW-FE7A16.svg?logo=stackoverflow&logoColor=white)](https://stackoverflow.com/tags/kentico-cloud)

Official site for GitHub Community in Kentico. This site is using [GatsbyJS](https://next.gatsbyjs.org) static site generation.

Data is stored in [Kentico Kontent](https://kontent.ai) and provided by [Gatsby source plugin](https://github.com/Kentico/gatsby-source-kontent).

Source code for the landing page is stored in [source branch](https://github.com/Kentico/kentico.github.io/tree/source) beacuse Organization pages bundle [has to be stored in master branch](https://help.github.com/articles/user-organization-and-project-pages/#user-and-organization-pages-sites).

## πŸš€ Quick start

1. **Install the dependencies**

```sh
npm install
```

Including Gatsby CLI installation.

3. **Start developing.**

```sh
npm run develop
```

4. **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://next.gatsbyjs.org/tutorial/part-five/#introducing-graphiql).*

### Build

To run the build process which builds the site to the `public` folder run:

```sh
npm run build
```

### Other

* Deployment set up and Azure function development is described in [wiki](https://github.com/Kentico/kentico.github.io/wiki)

## 🧐 What's inside?

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

.
β”œβ”€β”€ node_modules
β”œβ”€β”€ src
β”œβ”€β”€ .eslintrc
β”œβ”€β”€ .gitignore
β”œβ”€β”€ .travis.yml
β”œβ”€β”€ gatsby-browser.js
β”œβ”€β”€ gatsby-config.js
β”œβ”€β”€ gatsby-node.js
β”œβ”€β”€ gatsby-ssr.js
β”œβ”€β”€ LICENSE
β”œβ”€β”€ package-lock.json
β”œβ”€β”€ package.json
└── README.md

1. **`/node_modules`**: A directory where 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), like your site header, or a page template. β€œSrc” is a convention for β€œsource code”.

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

4. **`.eslintrc`**: This is a configuration file for a tool called [ESLint](https://eslint.org/), which is a tool to help keep the formatting of your code consistent.

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

6. **`gatsby-config.js`**: This is the main configuration 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://next.gatsbyjs.org/docs/gatsby-config/) for more detail).

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

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

9. **`LICENSE`**: This site is licensed under the MIT license.

10. **`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).

11. **`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.

12. **`README.md`**: A text file containing useful reference information about your project.

## πŸŽ“ Learning Gatsby

Looking for more guidance using Gatsby? Full documentation for Gatsby lives [on the website](https://next.gatsbyjs.org/). Here are some places to start:

- **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://next.gatsbyjs.org/tutorial/).** It starts with zero assumptions about your level of ability and walks through every step of the process.

- **To dive straight into code samples head [to our documentation](https://next.gatsbyjs.org/docs/).** In particular, check out the β€œGuides”, API reference, and β€œAdvanced Tutorials” sections in the sidebar.

## πŸ’« Deploy

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/Kentico/kentico.github.io)

* Note: this deploys only the front end of the application data. Data loaded from Github will be loaded from the production Azure table storage.

Information about the actual deployment is [decribed in wiki](https://github.com/Kentico/kentico.github.io/wiki/How-does-the-automatic-deployment-works).