Overview:
The AsyncAPI website contains various sources and is powered by Next.js with Tailwind CSS framework. It is built and deployed using Netlify and utilizes Storybook for frontend workshop and documenting UI components.
Features:
- Next.js Powered: Utilizes Next.js for efficient and fast website performance.
- Tailwind CSS Framework: Implements Tailwind CSS for a customizable and responsive design.
- Netlify Deployment: Built and deployed with Netlify for seamless deployment processes.
- Storybook Integration: Uses Storybook for frontend workshop and documenting UI components.
- Node.js and npm Requirements: Requires Node.js v20.12.0+ and npm v10.5.0+.
- Interactive Blog Post Creation: Ability to generate new blog posts through interactive prompts.
- Gitpod Codespace: Configured workspace for spinning up a Gitpod dev environment.
- Docker Support: Provides Docker support for running the website in development mode.
Installation:
- Fork the repository.
- Clone the forked repository locally:
git clone https://github.com/<username>/asyncapi-website
- Navigate to the website directory:
cd asyncapi-website
- Install dependencies:
npm install
- Run the website locally:
npm run dev
- Access the live development server at:
http://localhost:3000
- To run Storybook locally:
npm run storybook
- To lint the code:
npm run lint
- To build the production-ready website:
npm run build
Summary:
The AsyncAPI website is a versatile platform powered by Next.js and Tailwind CSS. It provides a seamless development experience with features like Storybook integration and Docker support. With clear instructions for installation and setup, developers can easily contribute to and enhance the project.