bodograumann/website

Website

Overview

This repository contains the sources of AsyncAPI website:

It's powered by Next.js,
It uses Tailwind CSS framework,
It's build and deployed with Netlify.

Requirements

Use the following tools to set up the project:

Node.js v12.16+
npm v6.13.7+

Usage

Install dependencies

To install all dependencies, run this command:

npm install

Develop

Launch the development server with the hot reloading functionality that allows any change in files to be immediately visible in the browser. Use this command:

npm run dev

You can access the live development server at localhost:8080.

Build

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

npm run build

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

Project structure

This repository has the following structure:

  ├── .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. It includes raw markdown files and React page templates.
  │    ├── about                  # Raw content for /about page
  │    ├── blog                   # Blog posts
  │    └── docs                   # Content for /docs/* pages
  ├── 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

bodograumann / website