Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iamfortune/ai-roadmap-generator
This is an AI Roadmap Generator application powered by Platformatic AI-warp and React (Vite).
https://github.com/iamfortune/ai-roadmap-generator
ai fastify platformatic react roadmap
Last synced: 19 days ago
JSON representation
This is an AI Roadmap Generator application powered by Platformatic AI-warp and React (Vite).
- Host: GitHub
- URL: https://github.com/iamfortune/ai-roadmap-generator
- Owner: iamfortune
- License: apache-2.0
- Created: 2024-06-10T12:44:11.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-06-27T12:13:42.000Z (7 months ago)
- Last Synced: 2024-11-05T19:14:26.548Z (2 months ago)
- Topics: ai, fastify, platformatic, react, roadmap
- Language: JavaScript
- Homepage: https://developer-roadmap.fly.dev
- Size: 163 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AI Roadmap Generator
This is an AI [Roadmap Generator](https://developer-roadmap.fly.dev) application powered by [Platformatic AI-warp](https://github.com/platformatic/ai-warp) and React (Vite). [Platformatic AI-warp](https://github.com/platformatic/ai-warp) handles authentication via [GitHub OAuth2](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) 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](https://github.com/platformatic/ai-warp): Handles AI processing and GitHub OAuth2 authentication.
- [Fastify Stattic](https://github.com/fastify/fastify-static): Serves the React frontend built with Vite.
- GitHub Authentication: Used for user authentication via [OAuth2](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app).
## 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](https://docs.microsoft.com/windows/wsl/) recommended).
- [Node.js](https://nodejs.org/) v20.6.0
- Docker
### Installation
1. **Clone the repository:**
```sh
git clone https://github.com/iamfortune/AI-Roadmap-Generator
cd Roadmap-Generator
```
1. **Install dependencies:**
In the root directory, install dependencies:
```sh
npm install
```
## Running the Application locally
### Using Docker
1. **Build the Docker image:**
```sh
docker build -t roadmap-generator:latest .
```
2. **Run the Docker container:**
```sh
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:
```env
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](https://github.com/platformatic/ai-warp?tab=readme-ov-file#documentation) and my article on the [Platformatic blog](https://blog.platformatic.dev/building-ai-applications-with-platformatic-ai-warp).
## Contributing
Contributions are welcome! Please fork the repository and submit a pull request for review.