Codebuddy is a Django-based workspace generator and task manager. It helps you turn a rough project idea into a structured plan, AI-generated workspace content, and a task list you can manage over time.
This guide is written for new users who want to get started quickly.
From the project folder, run:
cd /home/ayan/codebuddy
python -m venv venv
source venv/bin/activate
pip install django openai pydanticSet your OpenAI API key:
export OPENAI_API_KEY="your_openai_api_key"Run the database setup:
python manage.py migrateCreate an account for yourself:
python manage.py createsuperuserStart the app:
python manage.py runserverOpen the app in your browser:
- http://127.0.0.1:8000/admin/ for the Django admin site
- http://127.0.0.1:8000/projects/ for the main Codebuddy app
- Sign in to the app.
- Go to the Projects page.
- Click Create or New Project.
- Give your project a name and describe the idea you want to build.
- Choose the project type or category if prompted.
After creating a project, Codebuddy will guide you through a short setup flow.
Use this step to provide:
- the main problem your project solves
- the audience or users
- the goals of the project
- any important constraints or preferences
Be specific and clear. The better your answers, the better the AI-generated workspace will be.
Once you finish the setup questions:
- Click Generate Workspace.
- Wait for Codebuddy to build the project structure.
- Review the generated sections such as Overview, Requirements, Roadmap, Tasks, Resources, Budget, Learning, Documentation, and Testing.
You can treat this generated workspace as a starting point, not a final product. You can always revise it later.
After generation, you can:
- open workspace folders and sections
- read the generated content
- edit sections when needed
- regenerate individual sections if you want a fresh version
Use the workspace view to understand the project structure before you start detailed work.
Codebuddy also helps you break the project into tasks.
You can:
- create new tasks
- edit task names and descriptions
- set priorities
- mark tasks as in progress, review, or done
- add due dates and estimated hours
- create dependencies between tasks
A good habit is to update the task list whenever you make progress or discover new work.
If your project grows, use the board and timeline views to see progress more clearly.
- The board view is useful for tracking tasks by status.
- The timeline view helps you understand deadlines and milestones.
- The activity view shows recent changes and updates.
The built-in workspace assistant can help you:
- refine project ideas
- generate additional tasks
- review project health
- suggest improvements
- help resolve project issues
Use the assistant when you want second opinions or help organizing your plan.
Codebuddy includes tools to review your project over time.
You can:
- review the project health summary
- inspect conflict reports
- resolve or ignore issues
- review change history if you want to undo recent edits
These features are especially useful when your project becomes more complex.
- Start with one clear project idea.
- Answer setup questions thoughtfully.
- Keep task names short and actionable.
- Update tasks regularly as work progresses.
- Use the AI-generated workspace as a draft, then improve it manually.
- Review your project periodically instead of waiting until the end.
A typical workflow looks like this:
- Create a project.
- Describe your idea.
- Answer the discovery questions.
- Generate the workspace.
- Review the generated content.
- Create or adjust tasks.
- Track progress with the board or timeline.
- Use the assistant and review tools when needed.
If something does not work:
- make sure your virtual environment is active
- confirm your OpenAI API key is set correctly
- run migrations again if the database is out of date
- check that the development server is running
- create a new superuser if you cannot sign in
Codebuddy is most useful when you treat it as a planning and workspace-generation tool that helps you move from an idea to a structured project quickly. The fastest path to value is:
- create a project
- answer the setup questions
- generate the workspace
- refine the tasks and folders
- track progress over time