Welcome to our open-source chatbot application! This application is built using HTML, CSS and JavaScript along with EventSource and fetch APIs. It's a basic chatbot interface that communicates with a server via HTTP requests.
- Clone the repository to your local machine using
git clone <repo_link>
. - Use to create an env
cp .example.env .env.local
then update yourOPENAI_API_KEY
- Navigate to the project folder:
cd chatgpt-see
. - Run the
bash scripts/dev.sh
script to start the development server and build the application using Docker Compose. Or using Docker Composedocker-compose up --build
- Open your preferred web browser and navigate to
http://localhost:8000
to access the chatbot application. Swagger docs located athttp://localhost:8000/docs
Once you have the application running, you can start chatting with the bot:
- Type your message in the input field and hit the "Send" button or press Enter.
- The bot will process your message and send back a response, which will appear in the chatbox.
We welcome contributions from the community, from beginners to seasoned developers. Here's how you can contribute:
-
Fork the repository: Click on the 'Fork' button at the top right corner of the repository page on GitHub.
-
Clone the forked repository to your local machine:
git clone <forked_repo_link>
. -
Navigate to the project folder:
cd chatgpt-sse
. -
Create a new branch for your changes:
git checkout -b <branch_name>
. -
Make your changes in the new branch.
-
Commit your changes:
git commit -am 'Add some feature'
. -
Push to the branch:
git push origin <branch_name>
. -
Open a Pull Request: Go back to your forked repository on GitHub and click on 'Compare & pull request' to create a new pull request.
Please ensure that your code passes all the tests and if possible, add tests for new features. Always write a clear and concise commit message and pull request description.
Feel free to submit issues and enhancement requests. We're always looking for feedback and suggestions.
Ryan Eggleston
-[email protected]
This project is open-source, under the MIT License. Feel free to use, modify, and distribute the code as you please.
Happy Coding! ๐๐