/tech-ears

tech ears: the place where devs can learn english for free

Primary LanguageTypeScript

✨ Tech Ears - From Developers to Developers

Tech Ears is an open-source project designed by developers for developers, aimed at enhancing English language skills and providing practice for technical questions and interviews. Our platform offers a collaborative environment where developers can improve their communication skills while preparing for the challenges of technical interviews.

What can you do?

  • You can practice every day, without any fee.
  • Learn by listening real context developers routines.
  • Share your progress.

How can I help building Tech Ears?

  • Code Contributions: Improve the platform by adding new features, fixing bugs, or enhancing existing functionality.
  • Content Creation: Develop new exercises, questions, and scenarios to enrich the learning experience.
  • Feedback and Suggestions: Share your ideas and feedback to help us continuously improve Tech Ears.

Main Stacks

  • Node.js:A free, open-source, cross-platform JavaScript runtime environment that lets developers create servers, web apps, command line tools and scripts.
  • Yarn: Yarn is a package manager that doubles down as project manager.
  • Next Js: The React Framework for the Web

How to run:

  • Clone this repository:
git clone https://github.com/arthcc/tech-ears
  • Install NVM in order to easily run the recommended Node version for this project:
nvm install v20
nvm use

Now go to cd tech-ears and run yarn install

After that you can go to: http://localhost:3000 so you can run locally.

  • If you want to generate audios too, you need an API KEY, you can get one here: Eleven Labs API
  • Or a Google Cloud API Key

Running with Docker

  1. Clone this repository:

    git clone https://github.com/arthcc/tech-ears
  2. Navigate to the project directory:

    cd tech-ears
  3. Build the Docker containers:

    docker compose build
  4. Start the Docker containers:

    docker compose up
  5. To stop the Docker containers:

    docker compose down

These steps will build the Docker image once and then allow you to start and stop the containers quickly for development.

🧑‍💻 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. Just create a pull request with your suggestions and changes.

In addition to writing code, there are many ways for you to contribue.

You can contribute as following:

  • Create Issues
  • Giving your Feedback

You can read this repository’s Contributing Guidelines to learn how to contribute.