Skip to content
main
Switch branches/tags
Go to file
Code

README.md

The Algorithms official website

Language grade: JavaScript

This is a static Next.js site providing a searchable library of all the algorithms in The Algorithms. All the data about the algorithms get fetched from the DIRECTORY.md files in all the different repositories.

Getting Started

If you haven't installed it yet, install Node.js and yarn. Then, install all the dependencies:

yarn

After that, run the script that fetches all the algorithms from GitHub:

yarn fetch-algorithms

Finally, run the development server:

yarn dev

Open http://localhost:3000 with your browser to see the website.

Contributing

Try to use the Conventional Commits naming convention.

If you want to add a new feature or fix a bug, create a new branch or fork and commit there. Before opening a PR be sure to

  • Run yarn lint and fix potential errors
  • Run yarn build to check if everything still builds successfully

Open the pull request against main. Vercel will automatically create a preview deployment and the pull request will be squash merged after being reviewed by a member.

If you are a member and just want to add a small fix you can also directly commit to main instead of opening a pull request.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Powered by Vercel