Files
pear-docs/guide/starting-a-pear-terminal-project.md
Vivek Singh 3817bff892 Update guides (#134)
* update desktop guide

* update pear terminal guides

* fixes

* fix ctrl-c for example terminal app

* use SIGINT on readline close

---------

Co-authored-by: rafapaezbas <rafaelpaezbastida@gmail.com>
2024-08-27 12:15:39 +02:00

38 lines
899 B
Markdown

# Starting a Pear Terminal Project
{% embed url="https://www.youtube.com/watch?v=UoGJ7PtAwtI" %} Build with Pear - Episode 04: Pear Terminal Applications {% embeded %}
## Step 1. Init
First create a new project using `pear init --type terminal`.
```
mkdir chat-app
cd chat-app
pear init --yes --type terminal
```
This creates the base project structure.
- `package.json`. App configuration. Notice the `pear` property.
- `index.js`. App entrypoint.
## Step 2. Verify Everything Works
Use `pear run` to see that it works.
```
pear run --dev .
```
> A directory or link needs to be specified with `pear run`, here `.` denotes the current Project directory.
The app will now run. Note that it will keep running until you exit with `ctrl + c`.
That's all there is to getting a Pear Terminal project started.
## Next
* [Making a Pear Terminal Application](./making-a-pear-terminal-app.md)