Skip to content

Commit

Permalink
add local setup
Browse files Browse the repository at this point in the history
  • Loading branch information
harshsbhat committed Dec 21, 2024
1 parent c5b4018 commit 13c6898
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@

# Drizzle
DATABASE_URL="postgresql://postgres:password@localhost:5432/sealnotes"
UPSTASH_REDIS_REST_URL=""
UPSTASH_REDIS_REST_TOKEN=""

# Example:
# SERVERVAR="foo"
Expand Down
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,40 @@ SealNotes is an end-to-end encrypted web-based notepad that stores and manages y

- **No Tracking:** Sealnotes does not track user activity or store unnecessary metadata.

## Local Setup

- Clone the repo.

```
git clone https://github.com/harshsbhat/sealnotes.git
cd sealnotes
```

- Install dependencies:

```
pnpm install
```

- Create a `.env` file:

```
cp .env.example .env
```

- Create a Redis database with Upstash ( Upstash offers a serverless Redis database with a generous free tier of up to 10,000 requests per day. That's more than enough.) Add the following environment variables:

```
UPSTASH_REDIS_REST_URL=""
UPSTASH_REDIS_REST_TOKEN=""
```

- Run the project:

```
pnpm dev
```

## License

This project is licensed under the [MIT License](https://github.com/harshsbhat/sealnotes?tab=MIT-1-ov-file).
Expand Down

0 comments on commit 13c6898

Please sign in to comment.