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.

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

Readme edit #29

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 19 additions & 0 deletions .env.sample
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Get the Gemini API Key => https://aistudio.google.com/app/apikey
NEXT_PUBLIC_API_KEY=<Gemini API Key>

# Get the postgres data => https://vercel.com/docs/storage/vercel-postgres/quickstart
POSTGRES_DATABASE=
POSTGRES_HOST=
POSTGRES_PASSWORD=
POSTGRES_PRISMA_URL=
POSTGRES_URL=
POSTGRES_URL_NON_POOLING=
POSTGRES_URL_NO_SSL=
POSTGRES_USER=

REDIRECT_URL=http://localhost:3000
SECRET_KEY=<Any random string can be used here>

# How to get the spotify Client and Secret Key is in the readme
SPOTIFY_CLIENT_ID=
SPOTIFY_CLIENT_SECRET=
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,16 @@ Please ensure that your code follows the project's coding conventions and has ad
npm run dev
```

## How to get the client ID and Secret ID from spotify
- Go to [spotify for Developers](https://developer.spotify.com/)
- Login to your spotify Account
- Go to [your dashboard](https://developer.spotify.com/dashboard)
- [Create a new App](https://developer.spotify.com/dashboard/create)
- Fill in the app name `hearitfresh`, description as whatever you want, and the redirect urls to be `http://localhost:3000`, click on add and at the bottom of the page click on save
![Demo Screenshot](https://github.com/user-attachments/assets/913ae140-d95b-495b-bc1f-0d0c5d2c8222)
- After the project is created, go to settings and you'll find the client secret and ID to use
- Copy them and fill them in the env file as SPOTIFY_CLIENT_ID & SPOTIFY_CLIENT_SECRET, respectively

## πŸ›‘οΈ License

HearItFresh is licensed under the [MIT License](https://opensource.org/licenses/MIT).
Expand Down