chore: Update project directory name to prompt2code
This commit is contained in:
parent
fd6c942ee7
commit
09978eff66
80
README.md
80
README.md
|
|
@ -1,13 +1,4 @@
|
|||
<p align="center">
|
||||
<img src=".assets/devika-avatar.png" alt="Devika Logo" width="250">
|
||||
</p>
|
||||
|
||||
<h1 align="center">🚀 Devika - Agentic AI Software Engineer 👩💻</h1>
|
||||
|
||||
|
||||
|
||||
> [!IMPORTANT]
|
||||
> This project is currently in a very early development/experimental stage. There are a lot of unimplemented/broken features at the moment. Contributions are welcome to help out with the progress!
|
||||
<h1 align="center">🚀 Prompt2Code - Agentic AI Software Engineer 👩💻</h1>
|
||||
|
||||
## Table of Contents
|
||||
|
||||
|
|
@ -25,16 +16,12 @@
|
|||
|
||||
## About
|
||||
|
||||
Devika is an advanced AI software engineer that can understand high-level human instructions, break them down into steps, research relevant information, and write code to achieve the given objective. Devika utilizes large language models, planning and reasoning algorithms, and web browsing abilities to intelligently develop software.
|
||||
Prompt2Code is an advanced AI software engineer that can understand high-level human instructions, break them down into steps, research relevant information, and write code to achieve the given objective. Prompt2Code utilizes large language models, planning and reasoning algorithms, and web browsing abilities to intelligently develop software.
|
||||
|
||||
Devika aims to revolutionize the way we build software by providing an AI pair programmer who can take on complex coding tasks with minimal human guidance. Whether you need to create a new feature, fix a bug, or develop an entire project from scratch, Devika is here to assist you.
|
||||
Prompt2Code aims to revolutionize the way we build software by providing an AI pair programmer who can take on complex coding tasks with minimal human guidance. Whether you need to create a new feature, fix a bug, or develop an entire project from scratch, Prompt2Code is here to assist you.
|
||||
|
||||
> [!NOTE]
|
||||
> Devika is modeled after [Devin](https://www.cognition-labs.com/introducing-devin) by Cognition AI. This project aims to be an open-source alternative to Devin with an "overly ambitious" goal to meet the same score as Devin in the [SWE-bench](https://www.swebench.com/) Benchmarks... and eventually beat it?
|
||||
|
||||
## Demos
|
||||
|
||||
https://github.com/stitionai/devika/assets/26198477/cfed6945-d53b-4189-9fbe-669690204206
|
||||
> Prompt2Code is modeled after [Devika](https://github.com/stitionai/devika) which was modeled after [Devin](https://www.cognition-labs.com/introducing-devin) by Cognition AI.
|
||||
|
||||
## Key Features
|
||||
|
||||
|
|
@ -71,9 +58,9 @@ Version's requirements
|
|||
|
||||
### Installation
|
||||
|
||||
To install Devika, follow these steps:
|
||||
To install Prompt2Code, follow these steps:
|
||||
|
||||
1. Clone the Devika repository:
|
||||
1. Clone the Prompt2Code repository:
|
||||
```bash
|
||||
git clone https://git.telavivmakers.space/ro/prompt2code.git
|
||||
```
|
||||
|
|
@ -97,13 +84,13 @@ To install Devika, follow these steps:
|
|||
```bash
|
||||
playwright install --with-deps # installs browsers in playwright (and their deps) if required
|
||||
```
|
||||
5. Start the Devika server:
|
||||
5. Start the Prompt2Code server:
|
||||
```bash
|
||||
python devika.py
|
||||
python Prompt2Code.py
|
||||
```
|
||||
6. if everything is working fine, you see the following output:
|
||||
```bash
|
||||
root: INFO : Devika is up and running!
|
||||
root: INFO : Prompt2Code is up and running!
|
||||
```
|
||||
7. Now, for frontend, open a new terminal and navigate to the `ui` directory:
|
||||
```bash
|
||||
|
|
@ -111,26 +98,26 @@ To install Devika, follow these steps:
|
|||
bun install
|
||||
bun run start
|
||||
```
|
||||
8. Access the Devika web interface by opening a browser and navigating to `http://127.0.0.1:3001`
|
||||
8. Access the Prompt2Code web interface by opening a browser and navigating to `http://127.0.0.1:3001`
|
||||
|
||||
### how to use
|
||||
### How to use
|
||||
|
||||
To start using Devika, follow these steps:
|
||||
To start using Prompt2Code, follow these steps:
|
||||
|
||||
1. Open the Devika web interface in your browser.
|
||||
1. Open the Prompt2Code web interface in your browser.
|
||||
2. To create a project, click on 'select project' and then click on 'new project'.
|
||||
3. Select the search engine and model configuration for your project.
|
||||
4. In the chat interface, provide a high-level objective or task description for Devika to work on.
|
||||
5. Devika will process your request, break it down into steps, and start working on the task.
|
||||
6. Monitor Devika's progress, view generated code, and provide additional guidance or feedback as needed.
|
||||
7. Once Devika completes the task, review the generated code and project files.
|
||||
4. In the chat interface, provide a high-level objective or task description for Prompt2Code to work on.
|
||||
5. Prompt2Code will process your request, break it down into steps, and start working on the task.
|
||||
6. Monitor Prompt2Code's progress, view generated code, and provide additional guidance or feedback as needed.
|
||||
7. Once Prompt2Code completes the task, review the generated code and project files.
|
||||
8. Iterate and refine the project as desired by providing further instructions or modifications.
|
||||
|
||||
## Configuration
|
||||
|
||||
Devika requires certain configuration settings and API keys to function properly:
|
||||
Prompt2Code requires certain configuration settings and API keys to function properly:
|
||||
|
||||
when you first time run Devika, it will create a `config.toml` file for you in the root directory. You can configure the following settings in the settings page via UI:
|
||||
when you first time run Prompt2Code, it will create a `config.toml` file for you in the root directory. You can configure the following settings in the settings page via UI:
|
||||
|
||||
- API KEYS
|
||||
- `BING`: Your Bing Search API key for web searching capabilities.
|
||||
|
|
@ -152,32 +139,3 @@ when you first time run Devika, it will create a `config.toml` file for you in t
|
|||
Make sure to keep your API keys secure and do not share them publicly. For setting up the Bing and Google search API keys, follow the instructions in the [search engine setup](docs/Installation/search_engine.md)
|
||||
|
||||
|
||||
## Contributing
|
||||
|
||||
We welcome contributions to enhance Devika's capabilities and improve its performance. To contribute, please see the [`CONTRIBUTING.md`](CONTRIBUTING.md) file for steps.
|
||||
|
||||
## Help and Support
|
||||
|
||||
If you have any questions, feedback, or suggestions, please feel free to reach out to us. you can raise an issue in the [issue tracker](https://github.com/stitionai/devika/issues) or join the [discussions](https://github.com/stitionai/devika/discussions) for general discussions.
|
||||
|
||||
We also have a Discord server for the Devika community, where you can connect with other users, share your experiences, ask questions, and collaborate on the project. To join the Devika community Discord server, [click here](https://discord.gg/CYRp43878y).
|
||||
|
||||
## License
|
||||
|
||||
Devika is released under the [MIT License](https://opensource.org/licenses/MIT). See the `LICENSE` file for more information.
|
||||
|
||||
## Star History
|
||||
|
||||
<div align="center">
|
||||
<a href="https://star-history.com/#stitionai/devika&Date">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=stitionai/devika&type=Date&theme=dark" />
|
||||
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=stitionai/devika&type=Date" />
|
||||
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=stitionai/devika&type=Date" />
|
||||
</picture>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
We hope you find Devika to be a valuable tool in your software development journey. If you have any questions, feedback, or suggestions, please don't hesitate to reach out. Happy coding with Devika!
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user