Giter Club home page Giter Club logo

ai-roadmap-generator's Introduction

AI Roadmap

AI Roadmap is a website that allows users to create a minimal roadmap for their project by entering a description. The website is built using Next.js and NextUI for UI and components. We use Pocketbase, an open-source single-file backend, to store the data. We also use OpenAI's Chat-GPT service to generate the content for the roadmaps.

Screenshot

Installation

  1. Clone the repository.
  2. Fill the .env.local file with the following values:
  • POCKETBASE_URL=
  • POCKETBASE_ADMIN_EMAIL=
  • POCKETBASE_ADMIN_PASSWORD=
  • OPEN_AI_TOKEN=

You can find a sample in .env.example.

Backend

We use Pocketbase, a minimal and fast open-source backend similar to Firebase, to store the data. The schema of the tables can be found in the repository. More information about Pocketbase can be found in their GitHub repository.

OpenAI Chat-GPT

We use OpenAI's Chat-GPT service to generate the content for the roadmaps. We use the GPT-3.5-turbo model with a minimum of 15 items and a maximum of 30 items. The cost of each roadmap is $0.002 per 1K tokens, and each roadmap costs a minimum of 1200 tokens. This means that every 1000 roadmaps cost $2.

You will need to provide your OpenAI API key in the .env.local file under the OPEN_AI_TOKEN variable.

React Flow

We use React Flow to create the components for the roadmaps.

Credits

Design

You can find the Figma design for the UI here.

License

AI Roadmap is an open-source project with the MIT license. Feel free to use it, modify it, or distribute it.

ai-roadmap-generator's People

Contributors

amird308 avatar amirrezasalimi avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.