Skip to content

Latest commit

 

History

History
150 lines (105 loc) · 6.09 KB

README.md

File metadata and controls

150 lines (105 loc) · 6.09 KB
Raw

Logo

Talk with Spider-Man using your voice 😎
Explore the docs »

Report Bug · Request Feature

🛑⚠️ 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

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

(back to top)

📸 Screenshots

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

Home Page

Here's a demo of the working expected:

Home Page

This design was inpired by famous artworks on Dribbble.

(back to top)

📐 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
  2. 🌈 Setup the env file using cp .env.example .env.local
  3. 🔉 Add you Deepgram and OpenAI API key into the file. You just need to have an account, no extra configuration/training models required
  4. 👩‍💻 Test it out using npm run dev
  5. 🛠 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

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

(back to top)

👋 Reach Out

You can reach out to Mohit Yadav, the main creator of the app (for now) at mail ([email protected]), Twitter or Discord

Join Discord Server

If you Have any questions

 		Buy me a coffee

So I can keep on going

 		Visit website

Awesome projects

(back to top)

😋 License

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

(back to top)

😊 Acknowledgments

(back to top)

🥰 Endnote

Just one last thing, if you have reached this far, why not consider giving a star to the repo like many incredible people 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 😊🥰

~ Mohit