Skip to content
This repository has been archived by the owner on Jul 11, 2023. It is now read-only.

README update for .env files #22

Merged
merged 4 commits into from
Feb 16, 2023
Merged

README update for .env files #22

merged 4 commits into from
Feb 16, 2023

Conversation

justinliang1020
Copy link
Collaborator

Adds clarification to issue #17

  • specifies which .env files to copy from .env.example
  • adds clarification for example names

@vercel
Copy link

vercel bot commented Feb 15, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated
docs-promptable ❌ Failed (Inspect) Feb 16, 2023 at 1:06AM (UTC)

To run an example, clone the repo and follow these steps
1. Copy contents of `/apps/web/.env.example` into a new file, `/apps/web/.env`
2. Copy contents of `/examples/.env.example` into a new file, `/examples/.env.example` and add your [OpenAI API Key](https://openai.com/api/) to the `OPENAI_API_KEY` field
3. Run the following commands:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe a script would be great for this, when executing the example script a check verifies if the .env are present, if not, then it can do steps 1 and 2 automatically and ask the user for OpenAI API Key

Copy link
Collaborator Author

@justinliang1020 justinliang1020 Feb 16, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good idea, i'll make a separate issue for this (after this PR is closed)

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: Giuliano Kranevitter <[email protected]>
@cfortuner cfortuner merged commit 129e583 into main Feb 16, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants