Skip to content

Commit

Permalink
chore(readme): update readme
Browse files Browse the repository at this point in the history
updated readme to be more clear
added github link in the heaDer
added heading on the homepage
  • Loading branch information
AhsanAyaz committed Sep 24, 2024
1 parent a7a0ced commit 3bf003d
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 31 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,4 @@ jobs:
- run: npm ci --legacy-peer-deps
- uses: nrwl/nx-set-shas@v4

- run: npx nx affected -t e2e-ci --parallel=1
- run: npx nx affected -t e2e-ci
47 changes: 19 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,30 @@
# NgGcWs
# Angular Gemini Components Workspace

<a alt="Nx logo" href="https://nx.dev" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="45"></a>
A collection of Angular apps and libraries using the Gemini API

✨ Your new, shiny [Nx workspace](https://nx.dev) is almost ready ✨.
![banner](./assets/banner.png)

[Learn more about this workspace setup and its capabilities](https://nx.dev/getting-started/tutorials/angular-monorepo-tutorial?utm_source=nx_project&amp;utm_medium=readme&amp;utm_campaign=nx_projects) or run `npx nx graph` to visually explore what was created. Now, let's get you up to speed!
## Demo
- Sentiment Analysis Component
- [https://ahsanayaz.github.io/ng-gc-ws/](https://ahsanayaz.github.io/ng-gc-ws/)
- [YouTube video](https://youtu.be/IFt3XjWkpMk)

## Finish your CI setup
You will be asked about your Gemini API Key. But don't worry, it won't be stored, or seen by anyone.

[Click here to finish setting up your workspace!](https://cloud.nx.app/connect/H45WWQgkWV)
## Using this code repository locally

To get started, clone the repository, run `npm install` from the root of this workspace, and then create a file named `.env` inside the `apps/demo-app` folder.
Then add the following to it:

## Run tasks
```bash
NG_GC_GEMINI_API_KEY=YOUR_GEMINI_KEY
```

> Note: you can get your API key from [Google AI Studio](https://aistudio.google.com/)
## Run the demo app

To run the dev server for your app, use:
To run the dev server for the demo app, use:

```sh
npx nx serve demo-app
Expand Down Expand Up @@ -60,23 +71,3 @@ You can use `npx nx list` to get a list of installed plugins. Then, run `npx nx

[Learn more about Nx on CI](https://nx.dev/ci/intro/ci-with-nx#ready-get-started-with-your-provider?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)

## Install Nx Console

Nx Console is an editor extension that enriches your developer experience. It lets you run tasks, generate code, and improves code autocompletion in your IDE. It is available for VSCode and IntelliJ.

[Install Nx Console &raquo;](https://nx.dev/getting-started/editor-setup?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)

## Useful links

Learn more:

- [Learn more about this workspace setup](https://nx.dev/getting-started/tutorials/angular-monorepo-tutorial?utm_source=nx_project&amp;utm_medium=readme&amp;utm_campaign=nx_projects)
- [Learn about Nx on CI](https://nx.dev/ci/intro/ci-with-nx?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
- [Releasing Packages with Nx release](https://nx.dev/features/manage-releases?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
- [What are Nx plugins?](https://nx.dev/concepts/nx-plugins?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)

And join the Nx community:
- [Discord](https://go.nx.dev/community)
- [Follow us on X](https://twitter.com/nxdevtools) or [LinkedIn](https://www.linkedin.com/company/nrwl)
- [Our Youtube channel](https://www.youtube.com/@nxdevtools)
- [Our blog](https://nx.dev/blog?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
1 change: 1 addition & 0 deletions apps/demo-app/public/assets/github-mark-white.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 4 additions & 2 deletions apps/demo-app/src/app/app.component.html
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
<header>
<nav class="navbar bg-base-100">
<nav class="navbar bg-base-100 flex items-center justify-between">
<a class="btn btn-ghost text-xl">
Angular Gemini Demo App
</a>
<a class="px-4" target="_blank" rel="noreferrer noopener" href="https://github.com/AhsanAyaz/ng-gc-ws"><img src="/assets/github-mark-white.svg" class="w-4 h-4" alt="github logo" /></a>
</nav>
</header>
<main class="mx-auto max-w-3xl p-8">
<h2 class="text-xl mb-4 text-center">Angular Gemini Sentiment Analyzer</h2>
<form [formGroup]="form" class="form relative grid grid-cols-1 md:grid-cols-2 gap-4">
<div>
<select name="model" formControlName="model" class="select select-bordered w-full max-w-xs">
Expand All @@ -17,7 +19,7 @@
</div>
<div class="flex flex-col gap-4 items-end">
<textarea formControlName="inputTextVal" class="textarea w-full border-2 border-base-content"
placeholder="Type something to analyze the sentiment"
placeholder="Type something to analyze the sentiment of the text"
rows="3"></textarea>
<ng-gc-sentiment-analyzer [config]="sentimentConfig()" [text]="inputTextValDebounced()"></ng-gc-sentiment-analyzer>
</div>
Expand Down
Binary file added assets/banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3bf003d

Please sign in to comment.