Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update local development #28

Merged
merged 1 commit into from
Jun 13, 2024
Merged

docs: update local development #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 24 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
# Pdfun

PDF utilities
<!-- prettier-ignore-start -->
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/github/all-contributors/dalenguyen/pdfun?color=ee8449&style=flat-square)](#contributors)

<!-- ALL-CONTRIBUTORS-BADGE:END -->
<!-- prettier-ignore-end -->

[![Twitter](https://img.shields.io/twitter/follow/PDFun_xyz)](https://twitter.com/PDFun_xyz)

Open source PDF services. Built with:

- Analogjs (Angular)
- Nx Workspace
- Firebase
- GCP

![PDFun Demo](/docs/images/pdfun.png)

Expand All @@ -10,7 +24,15 @@ PDF utilities
yarn deploy
```

## Local development
## Local development (Web)

First, you need to rename the `.env-template` to `.env` and update the environment file.

> Tip: to turn Firebase service account to string for the environment, you can run `JSON.stringify(SERVICE_ACCOUNT_OBJECT)`.

After that, you can run `yarn deploy:rules` to deploy Firestore & Cloud Storage security rules.

## Local development (API)

Run the following command to set the default credentials

Expand Down
Loading