/chakshu

Primary LanguagePythonMIT LicenseMIT

Chakshu

Chakshu helps blind people read and navigate Wikipedia articles using voice commands.

Getting Started

Prerequisites

Make sure you have the following installed on your machine:

Installation

  1. Clone the repository:
git clone https://github.com/DhruvGoyal375/chakshu.git
cd chakshu
  1. Set up Poetry to create virtual environments within the project directory:
poetry config virtualenvs.in-project true
  1. Install dependencies using Poetry:
poetry install
  1. Activate the virtual environment:
poetry shell

Running the Project

Once the virtual environment is activated, you can run the project with:

python chakshu/manage.py runserver

Contributing

We welcome contributions from the community! Please read our Contribution Guidelines for detailed instructions on how to contribute to the project.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

If you have any questions or need further assistance, feel free to open an issue or contact the maintainers.