<div id="top"></div>

<!-- PROJECT Intro -->

<br />
<div align="center">
  <a href="https://github.com/Just-Moh-it/Spity-Sense/stargazers">
    <img src="https://user-images.githubusercontent.com/48997634/163501284-12a328ad-a690-4319-a1d8-3b5017a53b6d.png" alt="Logo" height="100">
  </a>

<p align="center">
    Talk with Spider-Man using your voice 😎
    <br />
    <a href="https://github.com/Just-Moh-it/Spity-Sense#top"><strong>Explore the docs »</strong></a>
    <br />
    <br />
    <a href="https://github.com/Just-Moh-it/Spity-Sense/issues">Report Bug</a>
    ·
    <a href="https://github.com/Just-Moh-it/Spity-Sense/issues">Request Feature</a>
  </p>
</div>

# 🛑⚠️ DISCLAIMER

> When I wrote the code for this project, only me and god knew what the hell I was doing. Now I guess only god knows.

This project isn't maintained 🥲, and requests to fix broken functionality on the app won't be welcome. Though if you'd want to make a pull request to improve the project, you're free to! 🤗

<!-- ABOUT THE PROJECT -->

# 💁 About The Project

Read the article here: https://dev.to/just_moh_it/introducing-spitey-sense-simulate-conversations-with-spider-man-using-gpt-3-and-deepgram-1ph2

<p align="right">(<a href="#top">back to top</a>)</p>

## 📸 Screenshots

Here is a sneak peek of the application and it's visuals 😍:

<div align="center">
  <img src="https://user-images.githubusercontent.com/48997634/163501381-69e294c4-eaec-40bc-9bdd-cb6ae9098709.png" alt="Home Page" />
</div>

Here's a demo of the working expected:

<div align="center">
  <img src="https://user-images.githubusercontent.com/48997634/163501553-843fdc47-52d5-494a-b6d2-1dc7efba63e5.gif" alt="Home Page" />
</div>

This design was inpired by famous artworks on Dribbble.

<p align="right">(<a href="#top">back to top</a>)</p>

<!-- Motivation -->

# 📐 Installation

To install spity sense, you need to have npm and NodeJS v14+ installed. If yes, proceed with these steps:

1. 💮 Clone the repo and cd into it
1. 🌈 Setup the env file using `cp .env.example .env.local`
1. 🔉 Add you Deepgram and OpenAI API key into the file. You just need to have an account, no extra configuration/training models required
1. 👩‍💻 Test it out using `npm run dev`
1. 🛠 All all goes working, use `npm run build` and then `npm run start`.

Note: Make sure to allow wss on nginx if you're using it behind a proxy ☘️.

<!-- CONTRIBUTING -->

# 🙃 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

<p align="right">(<a href="#top">back to top</a>)</p>

# 👋 Reach Out

You can reach out to Mohit Yadav, the main creator of the app (for now) at mail ([yo@mohitya.dev](mailto:yo@mohitya.dev)), [Twitter](https://twitter.com/Just_Moh_it) or [Discord](https://discord.gg/cqNbdEmazR)

<table>
  <tr>
    <td>
      <a href="https://discord.gg/cqNbdEmazR">
        <img src="https://user-images.githubusercontent.com/48997634/153762069-df7f5900-e685-45c9-8d30-a1a73bc28a8f.png" alt="Join Discord Server" />
        <p align="center">If you Have any questions</p>
      </a>
    </td>
    <td>
      <a href="https://www.buymeacoffee.com/JustMohit">
        <img src="https://user-images.githubusercontent.com/48997634/153762055-e1f311aa-1693-4dd9-9c19-e41cc17d2505.png" alt="Buy me a coffee" />
        <p align="center">So I can keep on going</p>
      </a>
    </td>
    <td>
      <a href="https://mohitya.dev">
        <img src="https://user-images.githubusercontent.com/48997634/153762079-d420fac9-ea94-48a9-b1ab-be045b83bef4.png" alt="Visit website">
        <p align="center">Awesome projects</p>
      </a>
    </td>
  </tr>
</table>

<p align="right">(<a href="#top">back to top</a>)</p>

<!-- LICENSE -->

# 😋 License

Distributed under the MIT License. See [`LICENSE.md`](LICENSE.md) for more information.

<p align="right">(<a href="#top">back to top</a>)</p>

<!-- ACKNOWLEDGMENTS -->

# 😊 Acknowledgments

- [Minh Pham](https://dribbble.com/phamduyminh) for designs

<p align="right">(<a href="#top">back to top</a>)</p>

# 🥰 Endnote

Just one last thing, if you have reached this far, why not consider giving a star to the repo like [many incredible people](stargazers) already have. This keeps us going, and we love to see that people like our projects, and motivates us to make more of these. With that, thank you loads 😊🥰

<p align="right">~ Mohit</p>

<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->

[contributors-shield]: https://img.shields.io/github/contributors/Just-Moh-it/Spity-Sense.svg?style=flat-square&logo=github
[contributors-url]: https://github.com/Just-Moh-it/Spity-Sense/graphs/contributors
[last-commit-shield]: https://img.shields.io/github/last-commit/Just-Moh-it/Spity-Sense?style=flat-square&logo=anchor
[last-commit-url]: https://github.com/Just-Moh-it/Spity-Sense/commit/main
[forks-shield]: https://img.shields.io/github/forks/Just-Moh-it/Spity-Sense.svg?style=flat-square&logo=curseforge
[forks-url]: https://github.com/Just-Moh-it/Spity-Sense/network/members
[stars-shield]: https://img.shields.io/github/stars/Just-Moh-it/Spity-Sense.svg?style=flat-square&logo=Apache-Spark
[stars-url]: https://github.com/Just-Moh-it/Spity-Sense/stargazers
[issues-shield]: https://img.shields.io/github/issues/Just-Moh-it/Spity-Sense.svg?style=flat-square&logo=testing-library
[issues-url]: https://github.com/Just-Moh-it/Spity-Sense/issues
[license-shield]: https://img.shields.io/github/license/Just-Moh-it/Spity-Sense.svg?style=flat-square&logo=gmail
[license-url]: https://github.com/Just-Moh-it/Spity-Sense/blob/master/LICENSE.md
