Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/razor-eng/algomaster

AlgoMaster is an interactive learning website designed to help you master Data Structures and Algorithms.
https://github.com/razor-eng/algomaster

Last synced: 14 days ago
JSON representation

AlgoMaster is an interactive learning website designed to help you master Data Structures and Algorithms.

Awesome Lists containing this project

README

        

# AlgoMaster

AlgoMaster is an interactive learning platform designed to help you master Data Structures and Algorithms. With a modern UI, theme switching, and an extensive library of resources, AlgoMaster makes learning engaging and efficient.

## Features

- Interactive navigation for easy access to content.
- Dark and Light theme support using `next-themes`.
- Modern, responsive UI built with Tailwind CSS and Radix UI components.
- Focused learning paths for Data Structures and Algorithms.

## Tech Stack

- **Frontend Framework:** [Next.js](https://nextjs.org/) (v14.1.0)
- **Styling:** [Tailwind CSS](https://tailwindcss.com/) (v3.4.1), [tailwindcss-animate](https://github.com/varletjs/tailwindcss-animate)
- **Icons:** [Lucide React](https://lucide.dev/)
- **Theming:** [next-themes](https://github.com/pacocoursey/next-themes)
- **UI Components:** [Radix UI](https://www.radix-ui.com/)
- **Diagramming:** [Mermaid.js](https://mermaid.js.org/)

## Installation

To get started with AlgoMaster, follow these steps:

1. Clone the repository:

```bash
git clone https://github.com/razor-eng/algomaster.git
```

2. Navigate to the project directory:

```bash
cd algomaster
```

3. Install dependencies:

```bash
npm install
```

4. Run the development server:

```bash
npm run dev
```

5. Open your browser and navigate to:
```
http://localhost:3000
```

## Available Scripts

- **`npm run dev`**: Starts the development server.
- **`npm run build`**: Builds the application for production.
- **`npm run start`**: Starts the production server.
- **`npm run lint`**: Lints the codebase.

## Dependencies

Here is a breakdown of the core dependencies used in this project:

### Core Dependencies:

- `@radix-ui/react-*`: A suite of accessible UI components.
- `lucide-react`: Icon library for modern web design.
- `mermaid`: Diagramming and charting tool.
- `next`: Framework for building React applications.
- `next-themes`: Theme management for Next.js projects.
- `react` & `react-dom`: React library for building UI.
- `tailwindcss`: Utility-first CSS framework.

### Dev Dependencies:

- `@types/*`: TypeScript type definitions.
- `autoprefixer`: Adds vendor prefixes to CSS.
- `eslint` & `eslint-config-next`: Linting tools.
- `postcss`: PostCSS for processing CSS.
- `typescript`: Superset of JavaScript.

## Folder Structure

```
algomaster/
├── components/ # Reusable UI components
├── pages/ # Next.js pages
├── public/ # Static assets
├── styles/ # Global styles and Tailwind CSS
├── lib/ # Utility functions
├── package.json # Project metadata and dependencies
```

## Contributing

Contributions are welcome! If you'd like to contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Commit your changes and push them to your branch.
4. Create a pull request.

## License

This project is licensed under the [MIT License](LICENSE).

## Acknowledgements

- Special thanks to the open-source community for the incredible libraries and frameworks used in this project.

---

Start learning and mastering Data Structures and Algorithms with AlgoMaster today!