> For the complete documentation index, see [llms.txt](https://editor-docs.ravenapp.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://editor-docs.ravenapp.dev/get-started/run-locally.md).

# Run Locally

**Clone the repository**

The first step is to have a local working copy of the repository. To do so follow these steps  -&#x20;

* Open the command prompt.
* Run the command git clone <https://github.com/ravenappdev/email-editor.git>

**Install the dependencies**

The email editor repository has two folders in it - app i.e., the frontend of email editor and server i.e., the backend of the email editor.

To install the dependencies of app follow these steps -&#x20;

* Change directory to app.
* Run command `npm install`

To install the dependencies of server follow these steps -&#x20;

* Change directory to server.
* Run command `npm install`

**Start Email Editor locally**

&#x20;To start the server locally -&#x20;

* Run command `npm run dev-start`

&#x20;To start the app locally -&#x20;

* For windows - Run command `npm run start-windows`
* For Linux - Run command `npm run start`&#x20;


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://editor-docs.ravenapp.dev/get-started/run-locally.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
