Skip to content

contributing.md

Latest commit

 

History

History
40 lines (29 loc) · 2.31 KB

contributing.md

File metadata and controls

40 lines (29 loc) · 2.31 KB

Contributing

Pull requests are welcome to help keep this list up to date.

Adding or updating a library

  1. Skim lib/features.ts to learn the feature flags so you can describe the library's capabilities accurately.
  2. Add or edit a YAML file in data/ — see the existing files for the schema (title, home URL, GitHub repo, npm package, license, supported frameworks, and features). This powers the interactive site.
  3. Add or update the library's entry in README.md by hand, keeping the list alphabetical. Separate the link and description with a dash, start the description with an uppercase letter, and end it with a period.
  4. Run npx awesome-lint to confirm the README still conforms to the Awesome list format.
  5. Open a pull request.

All library descriptions are adapted from each package's home page.

Local development

  1. Create a GitHub Personal Access Token. You don't need to give it any scopes — it's just to increase the API rate limit.
  2. (Optional) Create an NPM Access Token for more reliable NPM API reads and to avoid rate limits.
  3. Make sure you have Node.js version 22 or later and the pnpm package manager installed.
  4. Check out the repo and run pnpm install.
  5. Create a .env file in the root directory with your tokens: 
    GITHUB_TOKEN=your_github_token_here
NPM_TOKEN=your_npm_token_here
  6. Run pnpm dev.
  7. Go to http://localhost:3000/ and bask in the wild splendor that is Awesome JavaScript Grids.

Information on each library lives in data/ and is parsed in lib/libraries.ts.

How it's built

License

The curated list itself (the contents of README.md and data/) is dedicated to the public domain under CC0 1.0. The source code that builds and serves this site is licensed under the MIT License.