Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/TheAlgorithms/website
The Algorithms website providing GitHub's largest open-source algorithm library.
https://github.com/TheAlgorithms/website
algorithms hacktoberfest i18next nextjs static translations typescript vercel yarn
Last synced: 8 days ago
JSON representation
The Algorithms website providing GitHub's largest open-source algorithm library.
- Host: GitHub
- URL: https://github.com/TheAlgorithms/website
- Owner: TheAlgorithms
- License: mit
- Created: 2020-12-01T21:04:53.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T19:01:55.000Z (7 months ago)
- Last Synced: 2024-04-14T01:02:12.971Z (7 months ago)
- Topics: algorithms, hacktoberfest, i18next, nextjs, static, translations, typescript, vercel, yarn
- Language: TypeScript
- Homepage: https://the-algorithms.com
- Size: 5.86 MB
- Stars: 777
- Watchers: 20
- Forks: 162
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
The Algorithms Official Website
This is a static [Next.js](https://nextjs.org/) site providing a searchable library of all the algorithms in [The Algorithms](https://github.com/TheAlgorithms). All the data about the algorithms gets scraped directly from the git repositories.
## Translating the website
You can help us translate the [TheAlgorithms](https://the-algorithms.com) website using Weblate [here](https://hosted.weblate.org/engage/TheAlgorithms/?utm_source=widget). 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:
[](https://hosted.weblate.org/projects/TheAlgorithms/common/?utm_source=widget)
## Getting Started
If you haven't installed it yet, install [Node.js](https://nodejs.org/en/) and [yarn](https://classic.yarnpkg.com/en/docs/install#windows-stable). Then, install all the dependencies:
```bash
yarn
```
After that, run the script that fetches all the algorithms from GitHub:
```bash
yarn fetch-algorithms
```
Finally, run the development server:
```bash
yarn dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the website.
Alternatively, you can also use the [Ready-to-Code Gitpod](https://gitpod.io/#https://github.com/TheAlgorithms/website) 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 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.
## License
The source code of website itself (this repository) is licensed under [MIT](https://github.com/TheAlgorithms/website/blob/main/LICENSE), 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](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
