/OnlyAlgos

A Next JS website which shows the working of algorithms based on custom user input - A DSA project.

Primary LanguageTypeScript

This is the official repository of OnlyAlgos.

If you are interested in contributing to the codebase, you're most welcome! Read the README file to know the steps to contribute a new algorithm with your name as the contributor.

Steps to Contribute

First, fork the repository and clone it to your local environment.

Open the folder in your desired IDE and run the following command first.

npm install

The, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

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

To contribute a new algorithm on OnlyAlgos,

  1. create an entry in the @data/algos.ts
  2. create the following folder app/algos/<>/page.tsx where slug is the slug in your entry of @data/algos.ts
  3. In app/algos/<>/page.tsx, write your frontend code.
  4. For backend algorithm logics, create file <>.action.ts as a sibling of frontend i.e. app/algos/<>/page.tsx.
  5. Push your updated code on Github and Create a pull request.