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

• Platformatic AI-warp: Handles AI processing and GitHub OAuth2 authentication.
• Fastify Stattic: Serves the React frontend built with Vite.
• GitHub Authentication: Used for user authentication via OAuth2.

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 .

2. 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.