Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mckaywrigley/buildware-ai
Come join the best place on the internet to learn AI skills. Use code "buildwareai" for an extra 20% off.
https://github.com/mckaywrigley/buildware-ai
Last synced: 6 days ago
JSON representation
Come join the best place on the internet to learn AI skills. Use code "buildwareai" for an extra 20% off.
- Host: GitHub
- URL: https://github.com/mckaywrigley/buildware-ai
- Owner: mckaywrigley
- License: mit
- Created: 2024-07-10T17:54:42.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-09-28T02:36:05.000Z (3 months ago)
- Last Synced: 2024-12-06T16:22:19.042Z (8 days ago)
- Language: TypeScript
- Homepage: https://JoinTakeoff.com
- Size: 800 KB
- Stars: 521
- Watchers: 20
- Forks: 73
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: license
Awesome Lists containing this project
README
# Buildware
Buildware helps you ship code faster with AI.
Build a code instruction system, give it an issue, and get an AI-generated PR!
Built by [Mckay Wrigley](https://twitter.com/mckaywrigley) and [Tyler Bruno](https://twitter.com/tylerbruno05) at Takeoff AI.
## Demo
See the latest demo [here](https://x.com/mckaywrigley/status/1813695460600844362).
## Sponsor
If you find Buildware useful, please consider [sponsoring](https://github.com/sponsors/mckaywrigley) us to support our open-source work :)
## Updates
Coming soon:
- Advanced version with Linear integration and more
- Local codebase mode
- Team support
## Simple Setup
Follow these steps to get the simple version of Buildware running.
### 1. Clone the Repo
```bash
git clone https://github.com/mckaywrigley/buildware.git
```
### 2. Install Dependencies
```bash
npm install
```
### 3. Setup Environment Variables
Copy the `.env.example` file to `.env.local` and fill in the required variables.
```bash
cp .env.example .env.local
```
The following values are required for config for the simple version:
App Mode (keep default value):
- `NEXT_PUBLIC_APP_MODE=simple`
LLMs:
- `ANTHROPIC_API_KEY=`
- `OPENAI_API_KEY=`
Database:
- `DATABASE_URL=`
GitHub:
- `GITHUB_PAT=`
### 4. Setup Database
You will need a Postgres database to use Buildware.
We recommend using [Supabase](https://supabase.com/) or [Neon](https://neon.tech/).
Once you have your connection string, update the `DATABASE_URL` in the `.env.local` file.
Next, run the database migrations:
```bash
npm run migrate
```
Now your database is ready to use.
### 5. Setup GitHub PAT
You will need a GitHub PAT (Personal Access Token) to use Buildware.
Follow these steps:
1. Go to [this link](https://github.com/settings/tokens?type=beta).
2. Click "Generate new token".
3. Give your token a name and set the expiration date.
4. Select a "Resource owner".
5. Select which repositories you want to access. You must select either "All repositories" or "Only select repositories".
6. Select the 3 required repository permissions:
- Contents: Read and write
- Pull Requests: Read and write
- Metadata: Read-only (this is selected by default)
7. Click "Generate token".
8. Copy your new PAT.
Once you have your PAT, update the `GITHUB_PAT` in the `.env.local` file.
### 6. Run App
```bash
npm run dev
```
## Deploy Simple Version
Deploy the simple version to Vercel in 1 click:
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fmckaywrigley%2Fbuildware-ai&env=NEXT_PUBLIC_APP_MODE,ANTHROPIC_API_KEY,OPENAI_API_KEY,DATABASE_URL,GITHUB_PAT)
## Advanced Setup
Update (July 17th, 2024): Advanced setup guide coming soon! Please check back in a few days.