Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/json-schema-org/blog

The JSON Schema blog
https://github.com/json-schema-org/blog

blog community json-schema

Last synced: 7 days ago
JSON representation

The JSON Schema blog

Awesome Lists containing this project

README

        

---
📌 **Deprecation Notice** 📌

This repository is now deprecated. To contribute to JSON Schema's blog please use the new repository ➡️ [https://github.com/json-schema-org/website](https://github.com/json-schema-org/website).

---

# JSON Schema blog
[![Project Status: Moved to https://github.com/json-schema-org/website – The project has been moved to a new location, and the version at that location should be considered authoritative.](https://www.repostatus.org/badges/latest/moved.svg)](https://www.repostatus.org/#moved) to [https://github.com/json-schema-org/website](https://github.com/json-schema-org/websitem)

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/json-schema-org/.github/blob/main/CODE_OF_CONDUCT.md)[![Financial Contributors on Open Collective](https://opencollective.com/json-schema/all/badge.svg?label=financial+contributors)](https://opencollective.com/json-schema)

A fork from https://github.com/asyncapi/website at 34eba91120505a5065715337f73c66bfcf126736
In effort to avoid having to build a whole new blog and get something up quickly!
With complements of the AsyncAPI team!

TODO: Initial setup, Update link / info / description for JSON Schema in files such as...
- [x] scripts/build-rss.js
- [x] change favicon in the /public folders
- [x] update main description/keywords etc for page in the components/Head
- [x] update desc for footer in the components/Footer
- [x] Search whole repo for mention of AsyncAPI.
- [x] Google analytics tracking?
- [x] Include first article

---

## Overview

This repository contains the sources of JSON Schema blog website:

- It's powered by [Next.js](https://nextjs.org/)
- It uses [Tailwind](https://tailwindcss.com/) CSS framework
- It is deployed using cloudflare pages

## Requirements

Use the following tools to set up the project:

- [Node.js](https://nodejs.org/) v14.17+
- [yarn](https://yarnpkg.com/) v1.22+

We recommend using [Volta](https://volta.sh/) to easily use the correct versions of node and yarn

For image compression to webp you can use the [`cwebp`](https://developers.google.com/speed/webp/download) CLI. Maybe this can be automated as a GitHub Action?

## Usage

### Install dependencies

To install all dependencies, run this command:

```bash
yarn
```

Yarn [automagically](https://classic.yarnpkg.com/en/docs/cli/install/) installs the correct dependencies you need, develop by default.

### Develop

Launch the development server with the hot reloading functionality that allows any change in files to be immediately visible in the browser (code only, not content). Use this command:

```bash
yarn dev
```

You can access the live development server at [localhost:8080/blog](http://localhost:8080/blog).

### Build

To build a production-ready website, run the following command:

```bash
yarn build
```

Generated files of the website go to the `.next` folder.

## Project structure

This repository has the following structure:

```text
├── .github # Definitions of Github workflows, pull request and issue templates
├── components # Various generic components such as "Button", "Figure", etc.
├── config # Transformed static data to display on the pages such as blog posts etc.
├── context # Various React's contexts used in website
├── css # Various CSS files
├── lib # Various JS code for preparing static data to render in pages
├── pages # Website's pages source. Only the blog!
│ ├── blog # Blog posts
├── public # Data for site metadata and static content such as images
├── scripts # Scripts used in the build and dev processes
├── next.config.js # Next.js configuration file
├── postcss.config.js # PostCSS configuration file
└── tailwind.config.js # TailwindCSS configuration file
```