Skip to content

Commit 44a879f

Browse files
committed
docs: updated setup instructions for vercel dev
1 parent 9ac37db commit 44a879f

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
A diff viewer that gives you sharable diff view links but does not store your data. (This takes inspiration from typescript playground how it stores your code in url itself) but the for very large data we will be doing end to end encryption just like `excalidraw` so you can still have sharable links without worrying if you should store your enterprise data or not.
44

55
## :bangbang: No data sent to server
6-
You can take a look at the source code itself. All your data is kept as hash fragment in URL which never makes its way to server. Totally avoiding man in middle and XSS attacks to steal your data or any data breach. The data always stays in your URL and browser and never makes its way on the wire. Thats the main motive behind developing this tool. More about reasoning, why and how can be found in [Motivation](#motivation) section below.
6+
7+
You can take a look at the source code itself. All your data is kept as hash fragment in URL which never makes its way to server. Totally avoiding man in middle and XSS attacks to steal your data or any data breach. The data always stays in your URL and browser and never makes its way on the wire. Thats the main motive behind developing this tool. More about reasoning, why and how can be found in [Motivation](#motivation) section below.
78

89
# Formats currently supported
910

@@ -68,8 +69,15 @@ Please check all To dos and upcoming things [here](https://github.com/technikhil
6869
$ npm install
6970

7071
# serve with hot reload at localhost:3000
72+
# Note that the command below will serve only via nuxt server and
73+
# wont run vercel functions used for e2e encryption link generation
7174
$ npm run dev
7275

76+
# if you want to run vercel function during development
77+
# then first create a vercel project from this repo by logging in on vercel.com
78+
# then run following command and follow the instructions on terminal
79+
$ npx vercel dev
80+
7381
# build for production and launch server
7482
$ npm run build
7583
$ npm run start
@@ -79,14 +87,19 @@ $ npm run generate
7987
```
8088

8189
## Self Host
90+
8291
This guide provides detailed instructions on how to self-host the offline-diff-viewer application using Docker and Docker Compose. Self-hosting allows you to run the application on your own server, providing you with full control over its environment and configuration.
8392

8493
### Building and Running the Docker Container
94+
8595
1. Build the Docker Image
96+
8697
```bash
8798
$ docker build -t offline-diff-viewer .
8899
```
100+
89101
2. Run the Docker Container via docker run command
102+
90103
```bash
91104
$ docker run -d \
92105
--name offline-diff-viewer \
@@ -100,6 +113,7 @@ $ docker run -d \
100113
```
101114

102115
### Running the Container with Docker Compose
116+
103117
```bash
104118
$ docker compose up -d --build
105119
```

0 commit comments

Comments
 (0)