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.
- Clone the repository.
- Fill the
.env.localfile with the following values:
- POCKETBASE_URL=
- POCKETBASE_ADMIN_EMAIL=
- POCKETBASE_ADMIN_PASSWORD=
- OPEN_AI_TOKEN=
You can find a sample in .env.example.
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.
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.
We use React Flow to create the components for the roadmaps.
- Amirreza Salimi - Backend Developer
- Amir Damirchi - Frontend Developer
- Ehsan Ezzati - UI/UX Designer
You can find the Figma design for the UI here.
AI Roadmap is an open-source project with the MIT license. Feel free to use it, modify it, or distribute it.