diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..4eefeb3 --- /dev/null +++ b/.env.example @@ -0,0 +1,4 @@ +VITE_NEXT_PUBLIC_API_URL='' +VITE_AWS_REGION='' +VITE_TABLE_NAME='' +VITE_COMPANIES='' \ No newline at end of file diff --git a/.gitignore b/.gitignore index 5d9d311..b35792b 100644 --- a/.gitignore +++ b/.gitignore @@ -22,6 +22,7 @@ gitignore Thumbs.db .env* +!.env.example # vercel .vercel diff --git a/README.md b/README.md index 4453778..ca6b518 100644 --- a/README.md +++ b/README.md @@ -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 +