Code Monkey home page Code Monkey logo

ai-roadmap-generator's Introduction

AI Roadmap Generator

This is an AI Roadmap Generator application powered by Platformatic AI-warp and React (Vite). Platformatic AI-warp handles authentication via GitHub OAuth2 and processes AI prompts, while the React.js frontend application provides a user-friendly interface for generating and viewing roadmaps.

Technologies Used

Usage

To use, first authenticate with GitHub and add a keyword (frontend, backend, devops) for a roadmap.

Getting Started

Prerequisites

Platformatic supports

  • macOS, Linux and Windows (WSL recommended).
  • Node.js v20.6.0
  • Docker

Installation

  1. Clone the repository:
git clone https://github.com/iamfortune/AI-Roadmap-Generator
cd Roadmap-Generator 
  1. Install dependencies:

In the root directory, install dependencies:

npm install

Running the Application locally

Using Docker

  1. Build the Docker image:
docker build -t roadmap-generator:latest .
  1. Run the Docker container:
docker run --env-file .env -p 3042:3042 roadmap-generator:latest

This will start the application, and you can access it at http://localhost:3042.

Environment Variables

Create a .env file in the root of your project and add the following environment variables:

VITE_AI_URL=http://your-ai-service-url
PLT_AI_PROVIDER=
PLT_AI_MODEL=
PLT_AI_API_KEY=

For more information, refer to the AI Warp documentation and my article on the Platformatic blog.

Contributing

Contributions are welcome! Please fork the repository and submit a pull request for review.

ai-roadmap-generator's People

Contributors

iamfortune avatar

Stargazers

sammy. avatar

Watchers

 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.