Skip to content

Commit

Permalink
Add important fixes specially to Docs viewing
Browse files Browse the repository at this point in the history
  • Loading branch information
hamacjumar committed Sep 20, 2023
1 parent 6cc7ba2 commit 771f676
Show file tree
Hide file tree
Showing 19 changed files with 349 additions and 434 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ vsix/

# ignore these files
vsc-extension-quickstart.md
test.js
test.js
test.html
1 change: 1 addition & 0 deletions .vscodeignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ vsix/**
vsc-extension-quickstart.md
TODOs.txt
test.js
test.html
**/jsconfig.json
**/*.map
**/.eslintrc.json
Expand Down
81 changes: 32 additions & 49 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,13 @@

![Overview](./images/main-ss.png)

### Download DroidScript app from [Google Play](https://play.google.com/store/apps/details?id=com.smartphoneremote.androidscriptfree)

## What is DroidScript

![DroidScript Homepage](./images/droidscript-home-ss.png)

[DroidScript](https://droidscript.org/) is an easy to use, portable coding tool which simplifies android app development. It dramatically improves productivity by speeding up development by as much as 10x compared with using the standard development tools.

It’s also an ideal tool for learning JavaScript, you can literally code anywhere with DroidScript, it’s not cloud based and doesn’t require an internet connection.

Unlike other development tools which take hours to install and eat up gigabytes of disk space, you can install DroidScript in your phone and start using it within 30 seconds!

## About this extension

An extension to create, edit and run DroidScript apps directly in Visual Studio Code.

## Features

1. Create DroidScript projects in VS Code.
2. Initialize local folder as DroidScript project.
3. Edit DroidScript project files in VS Code.
4. Add, rename and delete DroidScript files in VS Code.
5. Run and Stop programs directly in VS Code.
6. Local folders initialized as DroidScript project serves as back up. You can then use Git to back up your files on GitHub.
7. DS Docs is directly in VS Code at DroidScript Panel section.
8. Samples can be viewed, copy and run directly in VS Code.
9. Upload, rename and delete DS projects assets directly in VSCode.
### Download DroidScript app from [Google Play](https://play.google.com/store/apps/details?id=com.smartphoneremote.androidscriptfree)

## Requirements

Expand All @@ -37,57 +17,60 @@ An extension to create, edit and run DroidScript apps directly in Visual Studio

> For version 0.27 and above, the documentation is displayed on the right panel served locally. To view docs smoothly, install the `"Live Preview"` extension [here](https://marketplace.visualstudio.com/items?itemName=ms-vscode.live-server).
## How to use?
## How to connect to DroidScript?

![Connect to DroidScript](./images/connect.gif)

Here are the steps in order to start editing your DroidScript projects in VS Code.
- Open DroidScript app on your phone and press the WiFi icon to start the DS WiFi IDE server. You should be able to see the IP Address on the popup message.
- Click the **"Connect"** button in the Projects section or in the Samples section. You can also click the **"Connect to DroidScript"** button in the bottom right corner.
- A popup will be displayed where to enter **"IP Address"** and **"Password"** if necessary.

1. Open DroidScript app on your phone and press the WiFi icon to start the DS WiFi IDE server. You should be able to see the IP Address on the popup message.
2. Create a folder in your laptop or desktop and open it in VS Code.
3. Once the VS Code is open, run **`DroidScript: Initialize`** command from the command pallete. Press (Shift - Ctrl/Cmd - P) to open command pallete.
4. When you run **DroidScript: Initialize** command, it will first display a popup where to `Enter IP Address`. Enter the IP Address as shown in DroidScript app.
5. If the IP Address is correct, another popup where to `Enter Password` is shown. Type your password and press `Enter`.
6. If the password is correct, a list dialog popup with the list of your DroidScript projects will be shown. Please select the project you want to work with.
## How to open an app?

You can now start editing your project files.
![Open an app](./images/open-app.gif)

> Tip: Make sure that a specific directory is associated to a specific DroidScript project. To open another DroidScript project, initialize another folder. This is to avoid files of multiple projects scrambled in one directory.
- If you are successfully connected, go to **DroidScript** view.
- Expand the **"PROJECTS"** section and select the project you want to open.
- A popup message will open on the bottom right for confirmation.

## Creating an app
## How to create an app?

![Control Actions](./images/create-app.png)
![Create an app](./images/create-app.gif)

Navigate to DroidScript panel in the SideBar to open DroidScript docs, projects and samples. Hover in the projects view title "PROJECTS", you can see the `"plus"` icon. Click it and choose the app type in the popup dialog.
- Go to **DroidScript** view.
- In the **"PROJECTS"** section title, click the **`"+"`** icon at the right.
- A quick pick popup will be shown at the top. Select the type of app and follow the next step to "Enter app name" and "App type".

## How to rename an app?

- Go to **DroidScript** view.
- Expand the **"PROJECTS"** section.
- Hover on the app you want to rename and click the **"Pencil"** icon.
- A popup message will open on the bottom right for confirmation.

## How to delete an app?

- Go to **DroidScript** view.
- Expand the **"PROJECTS"** section.
- Hover on the app you want to remove and click the **"Trash Bin"** icon.
- A popup message will open on the bottom right for confirmation.

## Play, Stop and Reload Project

![Control Actions](./images/run-stop-ss.png)
![Control Actions](./images/run-stop.gif)

At the bottom of VS Code, in the status bar you can see three icon buttons added, namely: **Reload**, **Play**, **Stop**.

- **Reload** - This will reload the current project files. Before you start editing your code, it is best practice to reload first in order to retrieved the updated files in your DroidScript project.
- **Play** - Run your DroidScript app.
- **Stop** - Stop the currently running app.

You can also you use command from the command pallette.

- **Reload** - `DroidScript: Reload` command
- **Play** - `DroidScript: Run` command
- **Stop** - `DroidScript: Stop` command

## Docs and Samples

![Control Actions](./images/samples-ss.png)

Navigate to DroidScript panel in the SideBar to open DroidScript docs and samples.

## All Commands


- `DroidScript: Initialize` - Initialize directory as a DroidScript project.
- `DroidScript: Reload` - Reload the files in the current folder.
- `DroidScript: Run` - Run the app associated with project folder.
- `DroidScript: Stop` - Stop the currently running DS app.


## Best Practices

Expand Down
7 changes: 1 addition & 6 deletions TODOs.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@

MAJOR

- Add Plugins Section in DroidScript Panel and display plugin docs when click.


Left
- Continue on "create-app". Remove `diamond` char if user is premium.
- Remove app path on DSCONFIG.localProjects if app is deleted.
- Do not display autocompletion dropdown when the token is a string
Loading

0 comments on commit 771f676

Please sign in to comment.