Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update readme #2942

Merged
merged 9 commits into from
May 18, 2024
104 changes: 84 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ This repository contains the sources of AsyncAPI website:

Use the following tools to set up the project:

- [Node.js](https://nodejs.org/) v16.0.0+
- [npm](https://www.npmjs.com/) v8.10.0+
- [Node.js](https://nodejs.org/) v20.12.0+
- [npm](https://www.npmjs.com/) v10.5.0+

## Run locally

Expand Down Expand Up @@ -117,6 +117,39 @@ After cloning repository to your local, perform the following steps from the roo

Now you're running AsyncAPI website in a development mode. Container is mapped with your local copy of the website. Whenever you make changes to the code, the website will refresh and changes visible in localhost:3000.

akshatnema marked this conversation as resolved.
Show resolved Hide resolved
## Lint the code
To lint the code, run the following command:
```
npm run lint
```

To fix the linting issues, run the following command:
```
npm run lint:fix
```

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add an extra check regarding lint mdx as well.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should I update lint commands in package.json as given below:

"lint": "next lint && npx remark ./**/*.mdx",
"lint:fix": "next lint --fix && npx remark ./**/*.mdx"

Or should I add new commands for this:

"lint:mdx": "npx remark ./**/*.mdx"

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is already a command as lint:mdx inside package.json.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

To lint the mdx files, run the following command:
```
npm run lint:mdx
```

## Start the production server
To build and run a production-ready website, run the following command:
```
npm run build && npm run start
```
Generated files of the website go in the `.next` folder.

## Start the netlify production server
Start a local development server for the build tool using the configuration and environment variables set for local development with the Netlify CLI:
```
netlify dev
```
To start the server using the configuration and environment variables set for `dev` or `all` deploy contexts, run the following command:
```
netlify dev --context production
```

## Updating information about project finance

AsyncAPI Financial Summary page aims to provide transparency and clarity regarding the organization's financial activities. It serves as a platform to showcase how donations are accepted, different sponsorship options, and how the generated funds are utilized.
Expand Down Expand Up @@ -196,24 +229,55 @@ This repository has the following structure:
<!-- If you make any changes in the project structure, remember to update it. -->

```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. It includes raw markdown files and React page templates.
│ ├── about # Raw blog for /about page
│ ├── blog # Blog posts
│ ├── docs # Blog for /docs/* pages
│ └── tools # Various pages to describe tools
├── public # Data for site metadata and static blog such as images
├── scripts # Scripts used in the build and dev processes
├── next.config.js # Next.js configuration file
├── netlify # Code that runs on Netlify
│ ├── edge-functions # Netlify Edge-Functions code
├── postcss.config.js # PostCSS configuration file
└── tailwind.config.js # TailwindCSS configuration file
├── .github # Definitions of GitHub workflows, pull request and issue templates
├── assets # Various assets
| ├── docs # Documentation assets
| | fragments # Docuentations for CLI installation and contribution.
├── 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
├── locales # Translations for the website
├── markdown # Markdown files for the website
├── about # Markdown files for the /about page
├── blog # Markdown files for the blog posts
├── docs # Markdown files for the /docs/* pages
├── netlify # Code that runs on Netlify
akshatnema marked this conversation as resolved.
Show resolved Hide resolved
├── pages # Website's pages source. It includes raw markdown files and React page templates.
│ ├── about # Raw blog for /about page
│ ├── blog # Blog posts
│ ├── docs # Blog for /docs/* pages
│ └── tools # Various pages to describe tools
├── public # Data for site metadata and static blog such as images
├── scripts # Scripts used in the build and dev processes
├── styles # Various CSS files
├── templates # Various template markdown files
├── types # Various typeScript types used in the website
├── utils # Various JS code for preparing static data to render in pages
├── .all-contributorsrc # File having details of all contributors
├── .dockerignore # Docker ignore file
├── .editorconfig # Editor configuration file
├── .eslintrc # ESLint configuration file
├── .gitignore # Git ignore file
├── .gitpod.yml # Gitpod configuration file
├── .remarkrc # Configuration file for remark
├── ADDING_TRANSLATIONS.md # Guide on how to add translations
├── CODE_OF_CONDUCT.md # Code of conduct
├── Contributing.md # Contributing guidelines
├── dashboard.json # Data for dashboard page
├── Dockerfile # Dockerfile for building the website
├── LICENSE # License file
├── mlc_config.json # Configuration file for markdown-link-checker
├── netlify.toml # Netlify configuration file
├── next-env.d.ts # Next.js environment types
├── next-i18next-static-site.config.js # Next.js i18next configuration file
├── next.config.mjs # Next.js configuration file
├── package-lock.json # NPM package lock file
├── package.json # NPM package configuration file
├── postcss.config.js # PostCSS configuration file
├── README.md # Project's README file
├── roadmap.json # Data for roadmap page
├── tailwind.config.js # TailwindCSS configuration file
└── tsconfig.json # TypeScript configuration file
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add only about tailwind.config.js, tsconfig.json, next.config.mjs, README.md files.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

```

## Connect with AsyncAPI Community
Expand Down
Loading