Welcome to the JACoB project! This repository is an open-source example showcasing the practical application of JACoB (Just Another Coding Bot). It's still early days for our robot friend, but don't let the name fool you - our goal is to make JACoB far more than just another bot. š¦¾š¦¾š¦¾
JACoB automates coding tasks, transforms Figma designs into deployable code, and integrates seamlessly into your existing development workflow. Think of JACoB as an AI-powered team member who writes, reviews, and optimizes code alongside your team, adapting to your unique coding style and preferences.
This repository is a living example of JACoB in action. Using the T3 Stack, we've set up a basic framework to build the jacb.ai home page for you to see how JACoB integrates with modern web development tools. It's a playground for you to experiment with JACoB's capabilities in a real-world scenario.
To see how JACoB was used to build out this site, check out this screencast showing the real-time creation of the site:
Interested in trying JACoB yourself? Hereās a quick guide to get you started with JACoB and integrate it seamlessly into your development workflow.
Important Note: Currently JACoB is in a limited beta preview. While JACoB has the potential to work across any codebase, we've focused initially on a limited number of languages and frameworks. Specficially, JACoB works best with a TypeScript Next.js application using Tailwind. More languages and frameworks are coming soon!
To begin, you need to install the JACoB AI Bot on your GitHub account. This bot will work with your repositories to automate coding tasks, review code, and manage pull requests.
Next, you need to run the JACoB custom setup command to create a jacob.config
file in your repository. This configuration file allows JACoB to understand your projectās specific needs and any environment variables essential for building the app.
npx jacob-setup create
jacob.config
file will be created. Open it and fill in the necessary details to customize it to your project."env": {
"NODE_ENV": "",
"NEXTAUTH_SECRET": "NEXTAUTH_SECRET",
"GITHUB_ID": "GITHUB_ID",
"GITHUB_SECRET": "GITHUB_SECRET",
"EMAIL_FROM": "EMAIL_FROM",
"DATABASE_URL": "file:./db.sqlite",
"NEXTAUTH_URL": "http://localhost:3000"
}
Note: Ensure that you never commit real secret keys. Use placeholders for standard build variables and replace them with actual values in your secure environment.
JACoB can convert your Figma designs into code, making the design-to-development process smoother.
Install the JACoB Figma plugin from Figma Community.
If everything worked smoothly, JACoB will start working on the task in the background. You should get a finished Pull Request after about 5 mintues, but you can follow along using the steps below:
Important Note: JACoB is in early development stages. The generated code is akin to what you might expect from an intern or junior developer - approximately 90% accurate. It's advisable to review and tweak the code manually before merging it into your main branch. The aim is to save you time, not to replace thorough code reviews and quality assurance.
By following these steps, you can integrate JACoB into your development process, enhancing efficiency and productivity. Remember, JACoB is a tool designed to assist and accelerate your coding process, not to replace the essential human touch in software development.
This project is built on the T3 Stack, a robust framework for efficient web development. For more details on the technologies used and deployment instructions, check out the links at the bottom of this readme.
Your insights and contributions are what make open-source great. Feel free to raise issues, submit pull requests, and provide feedback. Let's make software development more efficient, together!
This project is bootstrapped with create-t3-app
, keeping it simple yet scalable. You're starting with a solid scaffold that can evolve as your project grows.
For those new to the stack, refer to the respective docs of Next.js, NextAuth.js, Prisma, Tailwind CSS, and tRPC. Join our Discord for community support.
Check out the create-t3-app GitHub repository for more. Your feedback and contributions are always welcome!
Join us in redefining software development with JACoB. This is just the beginning! šš¤š»