Skip to content

daillfy/builder

 
 

Repository files navigation

Context Builder

TODO: one-line description

✨ Feature

  • TODO: feature 1
  • TODO: feature 2

🚀 Quick Start / Live Demo

Live demo: https://build.withcontext.ai

or

Run the app locally:

  1. Copy .env.example to .env.local and modify the value accordingly.
  2. Install Docker on your machine.
  3. Run docker compose up
  4. Visit http:https://localhost:3000

🧑‍💻 Contributing

Opening issues

Before you submit an issue, please check all existing open and closed issues to see if your issue has previously been resolved or is already known. If there is already an issue logged, feel free to upvote it by adding a 👍 reaction. If you would like to submit a new issue, please fill out our Issue Template to the best of your ability so we can accurately understand your report.

Good first issues

We have a list of good first issues that contain bugs that have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process.

Building additional features

To contribute to this project, we follow a "fork and pull request" workflow. Please do not try to push directly to this repo unless you are a maintainer.

First, please fork this repository.

Then clone your GitHub forked repository to your local machine:

git clone https://github.com/<your_github_username>/builder.git

Run the following commands at root directory:

# install dependencies
pnpm install

# run dev server
pnpm dev

Now you can start making changes to the code. Once you are done, please submit a pull request to the main branch of this repository. We will review your pull request and merge it if everything looks good.

For all Pull Requests, you should be extremely descriptive about both your problem and proposed solution. If there are any affected open or closed issues, please leave the issue number in your PR message.

Did you have an issue, like a merge conflict, or don't know how to open a pull request? Check out GitHub's pull request tutorial on how to resolve merge conflicts and other issues. Once your PR has been merged, you will be proudly listed as a contributor in the contributor chart.

Troubleshooting

Make sure your have these dependencies installed:

Enable Corepack to use pnpm as the package manager:

corepack enable

If you use VS Code, we recommend installing the following extensions:

📚 Recommend Reading

Libaries and tools used in this project:

EOF

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 79.9%
  • Python 18.9%
  • JavaScript 0.4%
  • CSS 0.4%
  • Dockerfile 0.3%
  • Mako 0.1%