The Algorithms website providing GitHub's largest open-source algorithm library.
npm install website
The Algorithms Official Website
This is a static Next.js site providing a searchable library of all the algorithms in The Algorithms. All the data about the algorithms gets scraped directly from the git repositories.
Translating the website
You can help us translate the TheAlgorithms website using Weblate here. There you can complete the translations for our current languages, or suggest something if you are unsure. Also feel free to add a new language. The current languages are:
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.
Alternatively, you can also use the Ready-to-Code Gitpod and easily check how your deployment looks. It will automatically run the commands mentioned above on run.
Contributing
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 lintand fix potential errors - Run
yarn buildto 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.
License
The source code of website itself (this repository) is licensed under MIT, while all the licenses for the code and explanations on the website can be found in the respective repositories.
Learn More
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
You can check out the Next.js GitHub repository - your feedback and contributions are welcome!
