Skip to content

Latest commit

 

History

History
154 lines (102 loc) · 5.62 KB

README.md

File metadata and controls

154 lines (102 loc) · 5.62 KB
Raw

Logo

Readable Brute Force

Built with love, Next.js & Flask.
https://safe-readable.vercel.app

About The Project

overview: presentation
You probably have visited sites before containing bad words, which might have caught you off guard. Suddenly stumbling upon these sites aren't exactly a good experience. We've made it easy for you to surf the web safely. Install our extension by visiting our site.

Built With

Challenges We ran into🔴

The biggest challenge we encountered was training the ml model since the model's accuracy was insufficient, thus we used a python tool to solve the problem. The second difficulty was that we couldn't update the DOM components to show the readability in the extension; as a result, we used an alert box instead.

Accomplishments that I'm proud of🎖

I was able to create our proper working extension extension along with the website(that had the extension). I learned more about webscrapping that I was new to. At last how to deploy a web application to vercel.

What I learned📚

I got more experience in Nextjs and web scrapping by building this application. Got to learn about different web scrapping techniques systems and how everything interacts in the web application during auth. I also wished to integrate this in the google playstore so that it be available to a wider audience.

What's next for Read_Brute_Force🎉

  • To blur vulgar Images
  • To ADD Age Constraints
  • To Deploy it in Cloud
  • ADD our extension on Chrome web store

Getting Started

Follow the instructions on our page to install the extension. To get a local copy up and running follow these simple example steps.

Installation Instructions

  1. Make sure that you have Python 3, gcc, venv, and pip installed.

  2. Clone the repository

        $ git clone https://github.com/ASLManasa/Readable_Brute_Force.git
    $ cd Readable_Brute_Force

  3. Installing Dependencies

    a. Backend

    Create a python 3 venv, activate the environment and Install the project dependencies.

        $ cd backend
    $ python -m venv venv
    $ venv\Scripts\Activate.ps1
    $ pip3 install -r requirements.txt

    b. Frontend

    Install all the Node Modules.

        $ cd frontend
    $ npm install

You have now successfully set up the project on your environment.

After Setting Up

To initialize the backend, run venv\Scripts\Activate.ps1 inside the backend folder.

  • python chat.py - Open Chatbot in Terminal
  • python main.py - Starts a server running at http://127.0.0.1:9696

To initialize the frontend inside the frontend folder,

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Project Gallery📷

1 2 4 3

License

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

Contributors


A.S.L.Manasa
Rohit Kumar Sah
Hemesh R.M.