From d72a66faa6a366f72159d309dc2e05f49fbec821 Mon Sep 17 00:00:00 2001 From: cichy380 Date: Sun, 21 Jan 2024 15:09:18 +0100 Subject: [PATCH] change description --- README.md | 56 ++++++----------------------------------- frontend/src/index.html | 2 +- 2 files changed, 9 insertions(+), 49 deletions(-) diff --git a/README.md b/README.md index 6832587..fd1fee0 100644 --- a/README.md +++ b/README.md @@ -1,57 +1,17 @@ # Speech to text - +This simple [Angular](https://angular.io/) and [NestJS](https://nestjs.com/)-based application showcases the effective utilization of the [Google's Speech-to-Text service](https://cloud.google.com/speech-to-text). It takes what the user speaks into their device's microphone and transcribes it into written text, which is then displayed on the screen. -✨ **This workspace has been generated by [Nx, a Smart, fast and extensible build system.](https://nx.dev)** ✨ +## Technology Stack -## Generate code +The application has been generated by [Nx](https://nx.dev), a fast and extensible dev tool and is built on [Angular](https://angular.io/) and [NestJS](https://nestjs.com/). [Angular](https://angular.io/) provides versatile choices for robust frontend development, whereas [NestJS](https://nestjs.com/) ensures a scalable and efficient build of the backend. -If you happen to use Nx plugins, you can leverage code generators that might come with it. +## Functionality -Run `nx list` to get a list of available plugins and whether they have generators. Then run `nx list ` to see what generators are available. +Upon initiating the application, the user is prompted with a simplistic interface where they can start speaking. The backend harnesses the power of [Google's Speech-to-Text service](https://cloud.google.com/speech-to-text) "under the hood" to transcribe this spoken language into written text. The transcribed text is then promptly displayed on the screen. -Learn more about [Nx generators on the docs](https://nx.dev/plugin-features/use-code-generators). +## Demo -## Running tasks +For a hands-on experience of our app, please follow to the [demo page](https://cichy380.github.io/speech-to-text/). -To execute tasks with Nx use the following syntax: - -``` -nx <...options> -``` - -You can also run multiple targets: - -``` -nx run-many -t -``` - -..or add `-p` to filter specific projects - -``` -nx run-many -t -p -``` - -Targets can be defined in the `package.json` or `projects.json`. Learn more [in the docs](https://nx.dev/core-features/run-tasks). - -## Want better Editor Integration? - -Have a look at the [Nx Console extensions](https://nx.dev/nx-console). It provides autocomplete support, a UI for exploring and running tasks & generators, and more! Available for VSCode, IntelliJ and comes with a LSP for Vim users. - -## Ready to deploy? - -Just run `nx build demoapp` to build the application. The build artifacts will be stored in the `dist/` directory, ready to be deployed. - -## Set up CI! - -Nx comes with local caching already built-in (check your `nx.json`). On CI you might want to go a step further. - -- [Set up remote caching](https://nx.dev/core-features/share-your-cache) -- [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) -- [Learn more how to setup CI](https://nx.dev/recipes/ci) - -## Connect with us! - -- [Join the community](https://nx.dev/community) -- [Subscribe to the Nx Youtube Channel](https://www.youtube.com/@nxdevtools) -- [Follow us on Twitter](https://twitter.com/nxdevtools) +> Note: The backend for this app is deployed on [Render.com](https://render.com/) - free hosting service. Please keep in mind that the initial usage may take a little longer (even 2 minutes!) due to Render.com's [Spinning down on idle](https://docs.render.com/free#spinning-down-on-idle) feature, which temporarily turns down free web services after 15 minutes of inactivity. However, the app should respond much faster in subsequent uses. diff --git a/frontend/src/index.html b/frontend/src/index.html index 641681f..1d745cd 100644 --- a/frontend/src/index.html +++ b/frontend/src/index.html @@ -2,7 +2,7 @@ - frontend + Speech-to-Text