/jungleBlog

Web-blog powered by ChatGPT, leading interactive conversations for dynamic and engaging content! 🚀🗣️

Primary LanguageSvelteMIT LicenseMIT

Jungle Blog

Jungle Blog - ChatGPT-powered Web-Blog Documentation

Welcome to the Jungle Blog GitHub repository! Jungle Blog is an innovative web-blog project that harnesses the capabilities of ChatGPT to create cool and engaging stories. This documentation provides essential information to help you understand, contribute, and deploy Jungle Blog.

Table of Contents

  1. Introduction
  2. Getting Started
  3. Usage
  4. Contributing
  5. Issues and Bug Reports
  6. License

Introduction

The motivation for creating this project was to explore the possibilities of the gpt chat API and various tools for working as a software engineer.

Getting Started

Prerequisites:

  • Node JS
  • PostgreSQL
  • ChatGPT API key (Get yours at OpenAI)

Installation

  1. Clone the Jungle Blog repository:
git clone https://github.com/thebaldehit/jungleBlog.git
cd jungleBlog
  1. Install dependencies:
cd backend
npm i
cd ../jungleBlog
npm i
cd ../adminPanel
npm i

Usage

Configuring ChatGPT

  1. Obtain a ChatGPT API key from OpenAI.
  2. Create .env file from .env.sample
  3. Setup .env file with your data (copy the token from the first subsection to .env )

Create DataBase

  1. Run create.js script to create DataBase (before it run Postgres service):
cd backend/db
node create.js

Deploying Jungle Blog

  1. Create .env file from .env.sample (if you have not done it yet)
  2. Fill data to .env (fill all fields otherwise app will not work)
  3. Run up:
cd backend
node index.js

Contributing

We welcome contributions! Please follow our contribution guidelines to get started.

Issues and Bug Reports

If you encounter any issues or want to report a bug, please open an issue on the issue tracker.

License

Jungle Blog is licensed under the MIT License.

Thank you for being part of the Jungle Blog community! Happy coding! 🌿📝