From 338f49119071b4f1374281cd14e163208c9d169f Mon Sep 17 00:00:00 2001 From: Eshal Shaikh Date: Wed, 30 Oct 2024 09:35:11 +0530 Subject: [PATCH] Update README.md --- README.md | 206 +++++++++++++++++++++++++++++++++--------------------- 1 file changed, 128 insertions(+), 78 deletions(-) diff --git a/README.md b/README.md index cb027504e..02888a5c6 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,16 @@ -# [Algo](https://ajay-dhangar.github.io/algo/) - Open Source Algorithm Repository +# ๐Ÿงฎ[Algo](https://ajay-dhangar.github.io/algo/) - Open Source Algorithm Repository -## introduction -Welcome to **Algo**, an open-source project that provides developers with algorithmic solutions and resources. Whether you're a beginner or an experienced coder, you can contribute, learn, and grow with us! ๐Ÿš€ +
+ +GT +
+ +animated-line-image-0382 -
+## ๐Ÿ“ Introduction +Welcome to **Algo**, an open-source project that provides developers with algorithmic solutions and resources. Whether you're a beginner or an experienced coder, you can contribute, learn, and grow with us! ๐Ÿš€ +animated-line-image-0382 +

@@ -13,9 +20,9 @@ Welcome to **Algo**, an open-source project that provides developers with algori - + - + @@ -24,16 +31,16 @@ Welcome to **Algo**, an open-source project that provides developers with algori - - - + + +
๐Ÿด Forks ๐Ÿ› Issues ๐Ÿ”” Open PRs๐Ÿ”• Close PRs๐Ÿ”• Closed PRs ๐Ÿ›  Languages๐ŸŒ Contributors ๐ŸŒ Contributors
Forks Issues Open Pull RequestsClose Pull RequestsGitHub language countGitHub contributorsClosed Pull RequestsGitHub language countGitHub contributors

- -## ๐Ÿš€Featured In +animated-line-image-0382 +## ๐Ÿš€ Featured In @@ -47,125 +54,167 @@ Welcome to **Algo**, an open-source project that provides developers with algori - + - + - +
GSSoC 24 GSSoC'24 Extd GSSoC'24 Extd is a one-month open-source Program conducted by the GirlScript Foundation. It is an initiative to introduce more beginners to Open-Source Software Development.ActiveActive โœ…
Hacktoberfest 2024 Hacktoberfest 2024 Hacktoberfest is a month-long celebration of open source software run by DigitalOcean, GitHub, and Twilio. It encourages contributions to open source projects and promotes a global community of developers.ExcludedExcluded โŒ

- - +animated-line-image-0382 ## ๐ŸŒ Demo Links -- [Demo](https://ajay-dhangar.github.io/algo/) - - -## Table of Contents +- [Demo](https://ajay-dhangar.github.io/algo/) ๐Ÿš€ +animated-line-image-0382 +## ๐Ÿ“š Table of Contents - [Algo - Open Source Algorithm Repository](#algo---open-source-algorithm-repository) - - [introduction](#introduction) - - [๐Ÿš€Featured In](#featured-in) - - [Table of Contents](#table-of-contents) - - [Project Overview](#project-overview) - - [Pick up Topics](#pick-up-topics) - - [Features](#features) - - [Website](#website) - - [Installation](#installation) - - [Local Development](#local-development) - - [Build](#build) - - [Deployment](#deployment) - - [Using SSH:](#using-ssh) - - [Not using SSH:](#not-using-ssh) - - [Contributing](#contributing) - - [Contributors โœจ](#contributors-) - - [Stargazers](#stargazers) - - [Forkers](#forkers) - - [Resources for Guidance](#resources-for-guidance) - - -## Project Overview + - [๐Ÿ“ Introduction](#introduction) + - [๐Ÿš€ Featured In](#featured-in) + - [๐ŸŒ Demo Links](#demo-links) + - [๐Ÿ“š Table of Contents](#table-of-contents) + - [๐Ÿ“– Project Overview](#project-overview) + - [๐Ÿ“Œ Pick up Topics](#pick-up-topics) + - [๐ŸŒŸ Features](#features) + - [๐ŸŒ Website](#website) + - [โš™๏ธ Installation](#installation) + - [๐Ÿ” Local Development](#local-development) + - [๐Ÿ—๏ธ Build](#build) + - [๐Ÿš€ Deployment](#deployment) + - [๐Ÿ”‘ Using SSH:](#using-ssh) + - [๐Ÿ“ก Not using SSH:](#not-using-ssh) + - [๐Ÿค Contributing](#contributing) + - [๐Ÿ‘ฅ Contributors โœจ](#contributors-) + - [๐ŸŒŸ Stargazers](#stargazers) + - [๐Ÿด Forkers](#forkers) + - [๐Ÿ“– Resources for Guidance](#resources-for-guidance) +animated-line-image-0382 +## ๐Ÿ“– Project Overview Algo provides a collection of well-documented algorithmic solutions written in various programming languages, covering a range of topics like sorting, searching, dynamic programming, and more. -### Pick up Topics +### ๐Ÿ“Œ Pick up Topics - [DSA Roadmap](https://roadmap.sh/datastructures-and-algorithms) We aim to: -- Create an extensive library of algorithms in different languages -- Help developers learn algorithmic problem-solving -- Foster open-source contribution and collaboration +- Create an extensive library of algorithms in different languages ๐ŸŒ +- Help developers learn algorithmic problem-solving ๐Ÿ’ก +- Foster open-source contribution and collaboration ๐Ÿค +animated-line-image-0382 +## ๐ŸŒŸ Features + +- **Multi-language Support**: Algorithms in multiple programming languages ๐ŸŒ +- **Beginner-Friendly**: Well-structured, easy-to-understand explanations ๐Ÿ“š +- **Open Source Contributions**: Welcoming developers at all levels to contribute ๐Ÿ™Œ +- **Community Forum**: A new interactive platform where developers can ask questions, share ideas, and collaborate in real-time. This forum will help bridge the gap between beginners and experts, allowing for deeper engagement and problem-solving ๐Ÿ’ฌ. +animated-line-image-0382 +## ๐ŸŒ Website + +This website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator ๐Ÿ› ๏ธ. -## Features +## โš™๏ธ Installation Guide -- **Multi-language Support**: Algorithms in multiple programming languages -- **Beginner-Friendly**: Well-structured, easy-to-understand explanations -- **Open Source Contributions**: Welcoming developers at all levels to contribute -- **Community Forum**: A new interactive platform where developers can ask questions, share ideas, and collaborate in real-time. This forum will help bridge the gap between beginners and experts, allowing for deeper engagement and problem-solving. +To set up the project on your local machine, follow these steps: -## Website +### ๐Ÿ“ฆ Prerequisites -This website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator. +Ensure you have the following software installed: -## Installation +- **Node.js** (version 14 or later) ๐ŸŒ: Download it from [Node.js Official Site](https://nodejs.org/). +- **npm** (Node Package Manager): It comes bundled with Node.js, so you don't need to install it separately. +### ๐Ÿ” Step 1: Clone the Repository + +First, clone the repository to your local machine. Open your terminal and run: ```bash - npm install + +git clone https://github.com/ajay-dhangar/algo.git ``` -## Local Development +๐Ÿ“ Step 2: Navigate to the Project Directory +Change into the project directory: +Copy code ```bash - npm start +cd algo ``` +โš™๏ธ Step 3: Install Dependencies +Install the project dependencies using npm. Run the following command: -This command starts a local development server and opens a browser window. Most changes are reflected live without having to restart the server. - -## Build +Copy code ```bash - npm run build +npm install ``` +๐Ÿ—๏ธ Step 4: Start Local Development Server +To start the local development server and open your browser, use: -This command generates static content into the `build` directory, which can be served using any static content hosting service. -## Deployment +Copy code +```bash +npm start +``` +This command will launch a development server and automatically open your default web browser. You can make changes to the code, and they will reflect live without needing to restart the server ๐Ÿ”„. -### Using SSH: +๐Ÿš€ Step 5: Build for Production +If you want to create a production build, run: +bash +Copy code ```bash - USE_SSH=true npm run deploy +npm run build ``` +This command compiles your project into static files for production and places them in the build directory ๐Ÿ“ฆ. + +๐Ÿ“ก Step 6: Deploy Your Application +If you're ready to deploy your application, use one of the following methods: -### Not using SSH: +๐Ÿ”‘ Using SSH: +If you prefer to deploy using SSH, run: + +bash +Copy code +```bash +USE_SSH=true npm run deploy +``` +๐Ÿ“ก Not Using SSH: +If you're not using SSH, you can deploy with: +bash +Copy code ```bash - GIT_USER= npm run deploy +GIT_USER= npm run deploy ``` +This command will build the website and push it to the gh-pages branch of your GitHub repository ๐Ÿ“ค. + +๐ŸŽ‰ That's it! +You are now set up and ready to develop! If you encounter any issues, please refer to the documentation or open an issue in the repository. -If you are using GitHub Pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. +vbnet +Copy code -## Contributing +This installation guide provides clear steps for users to follow, ensuring they can easily se -We welcome contributions from developers of all experience levels. For guidelines, please see the [CONTRIBUTING.md](./CONTRIBUTING.md) file. +animated-line-image-0382 -## Contributors โœจ +## ๐Ÿ’“ Contributors Thanks to these amazing people who have contributed to the **Algo** project: - +
+ -
+ - ajay-dhangar + ajay-dhangar
Ajay Dhangar @@ -1223,15 +1272,15 @@ Thanks to these amazing people who have contributed to the **Algo** project:
- -## Stargazers +animated-line-image-0382 +## โญStargazers [![Stargazers repo roster for @ajay-dhangar/algo](https://reporoster.com/stars/dark/ajay-dhangar/algo)](https://github.com/ajay-dhangar/algo/stargazers) - -## Forkers +animated-line-image-0382 +## ๐Ÿด Forkers [![Forkers repo roster for @ajay-dhangar/algo](https://reporoster.com/forks/dark/ajay-dhangar/algo)](https://github.com/ajay-dhangar/algo/network/members) - +animated-line-image-0382 ## Resources for Guidance Here are some resources that may be helpful as you contribute to Algo: - [Docusaurus Documentation](https://docusaurus.io/docs/docs-introduction) @@ -1245,3 +1294,4 @@ Here are some resources that may be helpful as you contribute to Algo: Back to Top +animated-line-image-0382