Skip to content

add env example and run instructions #10

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

Open
makedirectory wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add env example and run instructions #10

Show file tree
Hide file tree
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
4 changes: 4 additions & 0 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
VITE_NEXT_PUBLIC_API_URL=''
VITE_AWS_REGION=''
VITE_TABLE_NAME=''
VITE_COMPANIES=''
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ gitignore
Thumbs.db

.env*
!.env.example
# vercel
.vercel

Expand Down
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,8 @@ This is a tool to generate and send emails to data brokers to remove your detail
## Deploy Your Own

It's open source so you can deploy and run it yourself if you wish.

1. Run `yarn install`
2. Create env file using the example
3. Run `yarn run dev` for the development server