Skip to content
This repository has been archived by the owner on Jul 27, 2024. It is now read-only.

Commit

Permalink
Merge pull request #22 from pwgit-create/pwgit-create-patch-3
Browse files Browse the repository at this point in the history 
Update README.md
  • Loading branch information
@pwgit-create
pwgit-create authored Dec 21, 2023
2 parents 86cfabe + c82cf89 commit 0a15e2e
Showing 1 changed file with 19 additions and 41 deletions.
60 changes: 19 additions & 41 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,37 +1,30 @@
# Introducing App Wish: Turn Your App Ideas into Reality!

Have you ever dreamed of effortlessly bringing your app ideas to life? Imagine if you could simply write, "Make this app," and watch it come to fruition. Well, now you can!
# Turn Your App Ideas into Reality!

Introducing App Wish, a groundbreaking platform that empowers you to transform your app concepts into fully functional applications. Powered by an advanced Open AI model called davinci , App Wish takes your requests and generates the necessary code to build your app.

With App Wish, you can unleash your creativity without worrying about the complexities of coding. Whether you're a seasoned developer or a non-technical individual, this platform bridges the gap, making app development accessible to all.

Here's how it works: App Wish communicates with the Open AI model, gathering responses and crafting a complete app based on your specifications. But it doesn't stop there. App Wish goes the extra mile by attempting to compile the generated code. If it encounters any challenges during compilation, it perseveres, trying different approaches until it achieves a successful result.

Give your app ideas wings and let App Wish bring them to life. It's time to turn your imagination into functional reality with just a few simple requests.

Note: Please keep in mind that while App Wish strives to generate functional code, it's important to review and refine the output to ensure it aligns with your specific requirements and best practices.

Ready to make your app wishes come true? Let's get started with App Wish!
<br/><br/>
<br/>

## AppWish Quick Start Guide:
Follow these simple steps to get started with AppWish:

### 1. Set up your OPENAI API key:
#### 1. Set up your OPENAI API key

## Make sure you have the OPEN AI KEY
#### <i>Make sure you have the OPEN AI KEY!!</i>
* [Video instructions](https://www.youtube.com/watch?v=aVog4J6nIAU)
* [Web instructions](https://www.howtogeek.com/885918/how-to-get-an-openai-api-key/)

#### On Linux
<br/><br/>
#### <ins>On Linux<ins>
Add your OPENAI API key as an environment variable by executing the following command in the terminal:
```export OPENAI_TOKEN=YOUR_KEY```
#### On Windows (extra steps included)
#### <ins>On Windows <ins>
Add a new environment variable for your user called OPENAI_TOKEN and use your OPENAI API key as value
See article from howtogeek for more information: https://www.howtogeek.com/787217/how-to-edit-environment-variables-on-windows-10-or-11/

### 2.1 (only windows) Enable running unsigned scripts.
##### 2.1 Enable running unsigned scripts. (This step is only needed on Windows platforms)
2.1.1 Start Windows PowerShell with the "Run as Administrator" option
2.1.2 Enter: set-executionpolicy remotesigned in the console
Expand All @@ -40,16 +33,19 @@ See article from howtogeek for more information: https://www.howtogeek.com/78721
script running is disabled. It will allow local scripts to be run but
not remote ones (on your computer):

### 2. In your terminal, use the following command to start the application:
#### On Linux: ```make run```
#### On Windows( powershell or cmd): ```make run-win```
Note-2: If you still can't run the compile script (on a Windows computer), you can set the value to Unrestricted (see below)
set-executionpolicy Unrestricted

#### 2. In your terminal (CMD or Powershell on Windows and BASH on Linux), use the following command to start the application:
##### <ins>On Linux:<ins> ```make run```
##### <ins>On Windows<ins>( powershell or cmd): ```make run-win```


### 3. Once the application is running, you'll find a text box provided.
#### 3. Once the application is running, you'll find a text box provided.
Write down the desired features and specifications for your application in the text box.
Generate your application:

### 4. After defining your application features, click on the "Create" button.
#### 4. After defining your application features, click on the "Create" button.
With these steps, you'll be on your way to generating your desired application using AppWish. Get ready to witness the magic of turning your ideas into reality!

Note: Make sure to replace "YOUR_KEY" in Step 1 with your actual OPENAI API key for successful integration.
Expand All @@ -58,21 +54,10 @@ If you have any further questions or need assistance, feel free to ask. Happy ap
<br/><br/>:penguin:


## Discover the Path to Your Generated App Folder!
Exciting news! The apps generated by App Wish are now conveniently saved in a designated folder. You can find them at the following location:
### Discover the Path to Your Generated App Folder!
The apps generated by App Wish are now conveniently saved in a designated folder. You can find them at the following location:
#### On Linux: ```AppWish/AppWish/src/main/resources/java_source_code_classes_tmp```
#### On Windows ```AppWish\AppWish\src\main\resources\java_source_code_classes_tmp```
But that's not all. App Wish goes the extra mile by allowing you to run these applications directly within the platform, provided there are no input parameters required. Simply click on the class file and watch your app come to life!

However, in cases where input parameters are necessary, manual execution is required. Don't worry, it's a straightforward process. All you need to do is run the class file manually, ensuring that you provide the required input parameters.

App Wish empowers you to explore, test, and refine your apps effortlessly. Take advantage of the generated app folder path and the flexibility of running your applications either within the platform or manually with input parameters.

Let your apps shine and showcase their full potential with App Wish!

Note: It's important to review the generated code and perform necessary modifications, if any, before running the app. Additionally, make sure you have the required dependencies and configurations in place for seamless execution.

Ready to dive into your generated apps? Let's explore the possibilities with App Wish!

## Project information

Expand All @@ -90,13 +75,12 @@ Ready to dive into your generated apps? Let's explore the possibilities with App
4. Make



##### Credentials requirements <u>(Needed for API Key)</u>

* An account (free or paid) at OpenAI https://platform.openai.com/account/


## Unlock the Power of External Libraries for Your App Wishes!
### Unlock the Power of External Libraries for Your App Wishes!
Imagine a scenario where your app wishes are granted with incredible code, but you encounter a small hurdle - some of the required libraries don't exist in your current environment. Don't worry, we've got you covered!

App Wish provides a seamless solution to this challenge. If the generated code relies on non-existing libraries, you can easily incorporate them externally by downloading the necessary JAR files from the trusted Maven Repository. Once downloaded, simply add these libraries to your classpath, and watch your app come to life!
Expand All @@ -105,12 +89,6 @@ To assist you further, we've prepared a helpful video tutorial. It guides you th

Video Tutorial: [Adding External Libraries to Your App](https://www.youtube.com/watch?v=OYyVXv03h4o)

With App Wish, there are no limits to what you can achieve. Harness the power of external libraries, expand your app's functionality, and create amazing experiences for your users!

Note: It's important to exercise caution when downloading external libraries and ensure they come from trusted sources to maintain the security and stability of your app.

Ready to enhance your app wishes? Let's dive into the world of external libraries with App Wish!

## Videos - App Generation

* [Appwish Video mix](https://www.youtube.com/watch?v=2htjAD1L5v0&list=PL0iduoILay6AntUNHFFbKOOykfDnSP3Gy&index=8)
Expand Down

0 comments on commit 0a15e2e

Please sign in to comment.