Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Nimittxo authored Aug 30, 2024
1 parent 3a09920 commit 29cea1d
Showing 1 changed file with 149 additions and 1 deletion.
150 changes: 149 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,149 @@
# C-Practice
# AlgorithmicVault
## _Your EaseGuide to DataStructures and AlgorithmAnalysis,_

[![N|SOLID](https://cldup.com/dTxpPi9lDf.thumb.png)](https://nodesource.com/products/nsolid)

[![Build Status](https://travis-ci.org/joemccann/dillinger.svg?branch=master)](https://travis-ci.org/joemccann/dillinger)

AlgorithmicVault is like your personal algorithmic superhero! It's a quirky treasure trove of DSA & DAA solutions in popoular languages, turning your coding conundrums into child's play. Unleash the power of problem-solving and let the vault of algorithms save your day! 🦸‍♂️💻✨

- Type some code magic on the left
- Watch the algorithmic brilliance unfold on the right
- ✨ Code Alchemy ✨

## Features

- Upload your algorithm solutions and see them transform into a seamless collection
- Drag and drop code snippets and images (Dropbox integration makes it easy)
- Import and save files from GitHub, Dropbox, Google Drive, and OneDrive
- Effortlessly drag and drop code and documentation into AlgorithmicVault
- Export your algorithmic masterpieces in Markdown, HTML, and PDF

## Supported Languages

AlgorithmicVault covers a range of languages for Data Structures and Algorithm Analysis:

- [C](https://devdocs.io/c/) - Low-level powerhouses, a must-know!
- [C++](https://www.stroustrup.com/) - The godfather of memory management
- [Python](https://www.python.org/) - Easy-peasy, until algorithms get tough
- [Java](https://www.java.com/en/) - Classic and powerful, still a heavyweight
- [Node.js](https://nodejs.org/) - For server-side scripting and more
- [Rust](https://www.rust-lang.org/) - The modern language with a bright future


## Installation

Dillinger requires [Node.js](https://nodejs.org/) v10+ to run.

Install the dependencies and devDependencies and start the server.

```sh
cd dillinger
npm i
node app
```

For production environments...

```sh
npm install --production
NODE_ENV=production node app
```

## Plugins

Dillinger is currently extended with the following plugins.
Instructions on how to use them in your own application are linked below.

| Plugin | README |
| ------ | ------ |
| Dropbox | [plugins/dropbox/README.md][PlDb] |
| GitHub | [plugins/github/README.md][PlGh] |
| Google Drive | [plugins/googledrive/README.md][PlGd] |
| OneDrive | [plugins/onedrive/README.md][PlOd] |
| Medium | [plugins/medium/README.md][PlMe] |
| Google Analytics | [plugins/googleanalytics/README.md][PlGa] |

## Development

Want to contribute? Great!

Dillinger uses Gulp + Webpack for fast developing.
Make a change in your file and instantaneously see your updates!

Open your favorite Terminal and run these commands.

First Tab:

## Contributing to AlgorithmicVault

We’re thrilled you want to contribute! Here’s how you can get started:

### Forking the Repository

1. **Fork the Repository**: Go to the [AlgorithmicVault repository](#) and click on the "Fork" button at the top right. This creates a copy of the repository under your GitHub account.

2. **Clone Your Fork**: Open your terminal and clone your fork to your local machine:
```sh
git clone https://github.com/Nimittxo/AlgorithmicVault.git
```
Replace `your-username` with your GitHub username.

3. **Navigate to the Project Directory**:
```sh
cd AlgorithmicVault
```

### Making Changes

1. **Create a New Branch**: It’s best to create a new branch for your changes:
```sh
git checkout -b your-branch-name
```

2. **Make Your Changes**: Edit files and make your changes.

3. **Commit Your Changes**: Once you're done, add and commit your changes:
```sh
git add .
git commit -m "Your descriptive commit message"
```
4. **Push Your Changes**:
```sh
git push origin your-branch-name
```
### Creating a Pull Request
1. **Go to Your Fork**: Visit your fork on GitHub.
2. **Open a Pull Request**: You’ll see an option to create a pull request. Click on it and compare your branch with the base repository. Provide a description of your changes and submit the pull request.
## Docker
#### Coming soon!
## License
MIT
**Free Software, Hell Yeah!**
[dill]: <https://github.com/joemccann/dillinger>
[git-repo-url]: <https://github.com/joemccann/dillinger.git>
[john gruber]: <http://daringfireball.net>
[df1]: <http://daringfireball.net/projects/markdown/>
[markdown-it]: <https://github.com/markdown-it/markdown-it>
[Ace Editor]: <http://ace.ajax.org>
[node.js]: <http://nodejs.org>
[PlDb]: <https://github.com/joemccann/dillinger/tree/master/plugins/dropbox/README.md>
[PlGh]: <https://github.com/joemccann/dillinger/tree/master/plugins/github/README.md>
[PlGd]: <https://github.com/joemccann/dillinger/tree/master/plugins/googledrive/README.md>
[PlOd]: <https://github.com/joemccann/dillinger/tree/master/plugins/onedrive/README.md>
[PlMe]: <https://github.com/joemccann/dillinger/tree/master/plugins/medium/README.md>
[PlGa]: <https://github.com/RahulHP/dillinger/blob/master/plugins/googleanalytics/README.md>

0 comments on commit 29cea1d

Please sign in to comment.