https://github.com/thatbeautifuldream/ai-roadmap-generator
Generate Roadmaps with AI
https://github.com/thatbeautifuldream/ai-roadmap-generator
next-js prisma react-flow roadmapai server-actions side-project
Last synced: about 1 year ago
JSON representation
Generate Roadmaps with AI
- Host: GitHub
- URL: https://github.com/thatbeautifuldream/ai-roadmap-generator
- Owner: thatbeautifuldream
- License: mit
- Created: 2024-03-14T19:14:20.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T22:23:32.000Z (over 1 year ago)
- Last Synced: 2025-03-24T08:11:17.979Z (over 1 year ago)
- Topics: next-js, prisma, react-flow, roadmapai, server-actions, side-project
- Language: TypeScript
- Homepage: https://airoadmapgenerator.com
- Size: 8.91 MB
- Stars: 13
- Watchers: 1
- Forks: 2
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Roadmap AI
## Introduction
This project generates learning roadmaps for given search queries. For example, if a user searches for "machine learning", the project will generate a learning roadmap for machine learning. The roadmap will include the most important topics, resources, and learning paths for machine learning.
## Setting up the project locally
- We use `pnpm` for package management. You can install `pnpm` by following the instructions [here](https://pnpm.io/installation).
- To install the dependencies, run `pnpm install`.
- To start the development server, run `pnpm dev`.
- To build the project, run `pnpm build`.
- To start the production server, run `pnpm start`.
## Features
- Multimodel Support .
- Share roadmap via public URL.
- Recommended Orilley Books.
## Building and pusing the docker image to `ghcr.io` from the local machine
```bash
docker login ghcr.io
docker build . -t ghcr.io/thatbeautifuldream/ai-roadmap-generator:latest
docker push ghcr.io/thatbeautifuldream/ai-roadmap-generator:latest
```
## Pulling and running docker image on the server
```bash
docker pull ghcr.io/thatbeautifuldream/ai-roadmap-generator:latest
docker run -d -p 3000:3000 --name ai-roadmap-generator ghcr.io/thatbeautifuldream/ai-roadmap-generator:latest
```
