chart-gpt

Chart-GPT - Transforming Text into Stunning Charts Instantly

Chart-GPT is an innovative project designed to convert simple text inputs into visually appealing charts swiftly and efficiently. The project is open-source, hosted on GitHub, and its features are accessible to developers and contributors who wish to enhance its functionality or integrate it within their applications.

Getting Started with Chart-GPT

For those interested in utilizing Chart-GPT, the process begins by cloning the project repository from GitHub. This allows users to have their own copy of the project to work with. The project setup is straightforward:

1. Cloning the Repository: Users start by downloading the project files through Git commands. This is done by opening a terminal and executing:

   git clone https://github.com/whoiskatrin/chart-gpt.git
   cd chart-gpt
   

2. Environment Setup: To configure the project for development, users need to copy the example environment file to .env and provide their own PaLM API key, which is essential for accessing the chart creation functionality. The command below accomplishes this:

   cp .env.example .env
   

   Then, users need to add their API key to the .env file:

   BARD_KEY="your-api-key"
   

3. Installing Dependencies and Running the Server: Once the environment is set, the next step is to install necessary dependencies and launch the development server. Users can do this with either npm or yarn:

   npm install
   npm run dev
   

   Or with yarn:

   yarn
   yarn dev
   

   The development server then becomes accessible at http://localhost:3000, allowing exploration of Chart-GPT's functionalities.

To access the full functionality, users are encouraged to set up a credit system using Supabase, Stripe, and NextAuth with Google, which involves configuring additional environment variables as indicated in the .env.example file.

Contributing to Chart-GPT

Chart-GPT thrives on community participation, and contributions are warmly welcomed. The process to contribute is as follows:

1. Fork the Repository: Contributors first create a personal fork of the Chart-GPT repository. This personal fork allows them to make and test changes independently.

2. Clone the Forked Repository: After forking, contributors clone their personal copy onto their local machine:

   git clone <forked-repository-url>
   

3. Implement and Commit Changes: Contributors are encouraged to make improvements or additions, commit these changes, and push them back to their forked repository.

4. Create a Pull Request: Once changes are tested and deemed ready, contributors create a pull request from their forked repository back to the main Chart-GPT repository. This process involves proposing the changes for review and integration into the main project.

By following these steps, both developers and contributors can engage with and enhance Chart-GPT, aiding its growth and improving its capacity to transform text into charts effectively. The project invites both novice and experienced developers to explore, utilize, and contribute, ensuring it continues to evolve and serve the needs of users worldwide.