Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ratanshreshtha/grokkingcs

A computer science guide for people in hurry.
https://github.com/ratanshreshtha/grokkingcs

book computer-science

Last synced: 3 months ago
JSON representation

A computer science guide for people in hurry.

Awesome Lists containing this project

README

        

logo

GrokkingCS




A computer science guide for people in hurry.





contributors


last update


forks


stars


open issues


license




View Demo
·
Documentation
·
Report Bug
·
Request Feature



# :notebook_with_decorative_cover: Table of Contents

- [:notebook_with_decorative_cover: Table of Contents](#notebook_with_decorative_cover-table-of-contents)
- [:star2: About the Project](#star2-about-the-project)
- [:camera: Screenshots](#camera-screenshots)
- [:space_invader: Tech Stack](#space_invader-tech-stack)
- [:running: Run Locally](#running-run-locally)
- [:triangular_flag_on_post: Deployment](#triangular_flag_on_post-deployment)
- [:eyes: Usage](#eyes-usage)
- [:compass: Roadmap](#compass-roadmap)
- [:wave: Contributing](#wave-contributing)
- [:scroll: Code of Conduct](#scroll-code-of-conduct)
- [:warning: License](#warning-license)
- [:handshake: Contact](#handshake-contact)
- [:gem: Acknowledgements](#gem-acknowledgements)

## :star2: About the Project

GrokkingCS is an open source project for learning and revising computer science in a hurry for your upcoming technical interviews or just for fun it provides beautiful well organized layout along with interactivity.

### :camera: Screenshots


screenshot

### :space_invader: Tech Stack

Built With

### :running: Run Locally

If you'd like to develop and/or build the GrokkingCS book, you should:

Clone the project

```bash
git clone https://github.com/RatanShreshtha/GrokkingCS.git
```

Go to the project directory

```bash
cd GrokkingCS
```

Install dependencies

```bash
pip install -r requirements.txt
```

Edit the books source files located in the `src/` directory

Cleanup the old builds in local directory

```bash
jupyter-book clean src/
```

Build the notebook in local directory

```bash
jupyter-book build src/
```

A fully-rendered HTML version of the book will be built in `src/_build/html/`.

### :triangular_flag_on_post: Deployment

Please see the [Jupyter Book documentation](https://jupyterbook.org/publish/web.html) to discover options for deploying a book online using services such as GitHub, GitLab, or Netlify.

For GitHub and GitLab deployment specifically, the [cookiecutter-jupyter-book](https://github.com/executablebooks/cookiecutter-jupyter-book) includes templates for, and information about, optional continuous integration (CI) workflow files to help easily and automatically deploy books online with GitHub or GitLab. For example, if you chose `github` for the `include_ci` cookiecutter option, your book template was created with a GitHub actions workflow file that, once pushed to GitHub, automatically renders and pushes your book to the `gh-pages` branch of your repo and hosts it on GitHub Pages when a push or pull request is made to the main branch.

## :eyes: Usage

Use this interactive book by visiting https://ratanshreshtha.github.io/GrokkingCS/.

## :compass: Roadmap

- [x] Introduction
- [ ] Basic Programming
- [ ] Mathematics
- [x] Data Structures
- [x] Algorithms
- [x] Object Oriented Programming
- [ ] Design Patterns
- [ ] Computer Organization And Architecture
- [ ] Operating System
- [ ] Computer Networks
- [ ] Cryptography
- [ ] Database Design
- [x] System Design
- [ ] Testing
- [ ] Information Theory

See the [open issues](https://github.com/RatanShreshtha/GrokkingCS/issues) for a full list of proposed features (and known issues).

## :wave: Contributing



Contributions are always welcome!

See `CONTRIBUTING.md` for ways to get started.

### :scroll: Code of Conduct

Please read the [Code of Conduct](https://github.com/RatanShreshtha/GrokkingCS/blob/master/CODE_OF_CONDUCT.md)

## :warning: License

Distributed under the MIT License. See `LICENSE` for more information.

## :handshake: Contact

Ratan Kulshreshtha - [@RatanShreshtha](https://twitter.com/RatanShreshtha) - ratan.shreshtha[at]email_client.com

Project Link: [https://github.com/RatanShreshtha/GrokkingCS](https://github.com/RatanShreshtha/GrokkingCS)

## :gem: Acknowledgements

Use this section to mention useful resources and libraries that you have used in your projects.

- [Shields.io](https://shields.io/)
- [Awesome README](https://github.com/matiassingers/awesome-readme)
- [Emoji Cheat Sheet](https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md#travel--places)
- [Jupyter Book project](https://jupyterbook.org/)
- [executablebooks/cookiecutter-jupyter-book template](https://github.com/executablebooks/cookiecutter-jupyter-book)