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

chore: update documentation #11

Merged
merged 2 commits into from
Mar 13, 2024
Merged

chore: update documentation #11

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
df8285f
chore: update documentation
developerjamiu Mar 13, 2024
62e144f
chore: pr review
developerjamiu Mar 13, 2024
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
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,12 @@

The mobile version of the [Article Idea Generator](https://www.articleideagenerator.com/).

Built with ❤️ Powered by OpenAI.
## Getting started

To test the project
- run git clone [email protected]:Olanetsoft/article-idea-generator-mobile.git in your terminal
- navigate to the directory containing the cloned project
- head over to https://ai.google.dev/ to create a `geminiApiKey`
- create an `env.json` file in the root directory (check the `env-example'json` as sample)

Built with ❤️ Powered by Google Gemini.
developerjamiu marked this conversation as resolved.
Show resolved Hide resolved
4 changes: 3 additions & 1 deletion env-example.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
{
"apiUrl": "https://www.example.com"
"apiUrl": "https://www.example.com",
"geminiApiKey": "AIzaSyCKC238Kdc5sAe_plBxxWZrHvgM4t__lHI",
"initialPrompt": "Return a 5 list of article ideas with the following rules and payload. If seoEnabled is true in the payload, make the list seo optimized. Return only the list without any title or description and without any form of numbering or formatting; just plain text."
}
Loading