https://github.com/rs-labhub/nerdbook

nerdBOOK, where nerds learn!
https://github.com/rs-labhub/nerdbook

mindsdb

Last synced: 4 months ago
JSON representation

nerdBOOK, where nerds learn!

• Host: GitHub
• URL: https://github.com/rs-labhub/nerdbook
• Owner: RS-labhub
• License: mit
• Created: 2024-07-06T02:49:41.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-09T11:32:23.000Z (almost 2 years ago)
• Last Synced: 2025-06-21T09:18:43.230Z (12 months ago)
• Topics: mindsdb
• Language: HTML
• Homepage:
• Size: 53.5 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          


    





    






# 🤓📖 nerdBOOK 

 **nerdBOOK** is a web application which lets learn programming featured with *cpp language*. You'll get books, ask your queries and learn from them, and last but not the least, you get a cpp code playground, where you can play with your codes and get debugging suggestions, if got any!




## 🪶 Features

- **Free CPP BOOKs** 📖: nerdBOOK will provides with different cpp books from OS building to Games development using CPP 🧑‍💻.

- **Learning Assistant** ✒️: Unable to understand a topic? Or want to revise with key points of the specific topics?? We made a learning assitant powered by *Minds DB* 🧠.

- **CPP Playground** 🚀: Learnt everything? Now it's time to test your skills! Go and play with codes in the playground. Getting bugs? Don't worry AI will tell you the debug suggestions 🥹

- **Radhika(Radha) Code Helper Chatbot** 🤖: Facing trouble in writing codes when on playground?? Use Radha's Code Helper Chatbot. She will assist you with approach and provides you to the code. 💘

#

# :books: Index

- [Demo](#movie_camera-Demo)

- [Screenshots](#screenshots)

- [Set Up](#outbox_tray-Set-up)

- [Contribute](#building_construction-Contribute)

- [Project Author](#people_holding_hands-Meet-the-Author)

- [Contact](#email-contact)

#

#  :movie_camera: Demo

- After a brief introduction, let's dive a little more inside the project.

- Here is the walk-through of **nerdBOOK**. If you want to witness a more a hd version, [click here](frontend/assets/nerdBOOK.mp4)

[![nerdBOOK](frontend/assets/thumbnail.png)](https://youtu.be/qexMcguP0vM)

Video Demonstration


> [!TIP]

> Unable to play? Watch here: https://youtu.be/qexMcguP0vM




## Screenshots



  

  
Landing Page 📟

  


  


  

  
nerdBOOK features 💽

  


  


  

  
nerdBOOK BookShop 📚

  


  


  

  
nerdBOOK Learning Assistant 🤖

  


  


  

  
nerdBOOk CPP Playground 🛝





## Dependecies

1. **HTML**

2. *CSS*

3. **JavaScript**

4. *Bootstrap*

5. **Minds DB**

6. *Python*

#

##  :outbox_tray: Installation Guide

- These are the steps required to install and run the nerdBOOK project:

1. Clone the Repository: Open a terminal or command prompt and clone the nerdBOOK repository from GitHub using the following command:

  ```bash

    git clone https://github.com/RS-labhub/nerdBook

  ```

2. Navigate to the Repository Directory: Change your current directory to the cloned nerdBOOK repository:

  ```bash

    cd nerdBook

  ```

3. Install Dependencies: Use pip to install the required dependencies listed in the requirements.txt file:

  ```bash

    pip install -r requirements.txt

  ```

4. Run nerdBOOK application using the following command:

  ```py

    ctrl + shift + P

  ```

5. Once the application is running, enjoy it!.




> [!NOTE]

> Run node server.js and node compiler.js simulatenously in differently terminals.

## What to do after installation?

Once nerdBOOK is installed and running, you can use it to get your enhance your learning.

> [!IMPORTANT]

> REPLACE THE API KEY WITH YOUR API KEY, you can get it from here https://mdb.ai

$~$

# Setup and Contributing Guidelines

    

**Set Up Your Environment**

1. `Fork` our repository to your GitHub account. 

2. `Clone` your fork to your local machine. 

    Use the command `git clone https://github.com/RS-labhub/SeedLink-Shepherd.git`.

3. Create a new branch for your work. 

    Use a descriptive name, like `fix-login-bug` or `add-user-profile-page`.

    

**Commit Your Changes**

- Commit your changes with a _clear commit message_. 

  e.g `git commit -m "Fix login bug by updating auth logic"`.

**Submit a Pull Request**

- Push your branch and changes to your fork on GitHub.

- Create a pull request, compare branches and submit.

- Provide a detailed description of what changes you've made and why. 

  Link the pull request to the issue it resolves. 🔗

    

**Review and Merge**

- I will review your pull request and provide feedback or request changes if necessary. 

- Once your pull request is approved, we will merge it into the main codebase 🥳

$~$

## :people_holding_hands: Meet the Author



### :email: Contact 

- Email: rs4101976@gmail.com

- Head over to my github handle from [here](https://github.com/RS-labhub)

















   Thank you for visting this Repo 
If you like it, star ⭐ it