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

Update Readme #3

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update Readme #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
76 changes: 48 additions & 28 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,8 @@
# This is a Demo app showcasing Symbl.AI capabilities
# Nextjs-symblai-demo
Copy link
Contributor

Choose a reason for hiding this comment

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

@neerajchaudharySymbl May you put the README template's language in here?


## Introduction
Symbl is a comprehensive suite of APIs for analyzing natural human conversations - both for your team’s internal conversations and of course the conversations you are having with your customers. Built on our Contextual Conversation Intelligence (C2I) technology, the APIs enable you to rapidly incorporate human-level understanding that goes beyond simple natural language processing of voice and text conversations.

# Getting started

To get started, you’ll need your account credentials and Node.js installed (> v8.x) on your machine.

Your credentials include your appId and appSecret. You can find them on the home page of the platform.

![App ID](https://docs.symbl.ai/images/credentials-faf6f434.png)

After you retrieve them, you need to set them up under `.env` file in this repo

```
APP_ID=
APP_SECRET=
```

## About this app.

This app is using [ReactJS](https://reactjs.org/), [Typescript](https://www.typescriptlang.org/) and [NextJS](https://nextjs.org/). Let's take a look at folder structure

- `pages` In Next.js, a page is a React Component exported from a `.js`, `.jsx`, `.ts`, or `.tsx` file in the pages directory. Each page is associated with a route based on its file name. You can read more about how NextJS works with pages [here](https://nextjs.org/docs/basic-features/pages)
Expand All @@ -35,9 +19,25 @@ On the first page of the app we showcase how you can call to your phone number (

Symbl has REST API to do majority of things like getting insights, processing audio, video and text, get conversation data and much more. Rest of the pages of the app are focused on this API and showcase different use cases of Symbl from getting tasks and questions from existing conversation to uploading and processing video and audio files. You can even get transcriptions from the video and by clicking on these transcriptions, navigate to specific parts of the video. You can see this behavior on `/video` page.

# Running app locally

add credentials to `next-config.js` file filling in `APP_ID` and `APP_SECRET` variables.
## Pre-requisites
To get started, you’ll need your account credentials and Node.js installed (> v8.x) on your machine.Your credentials include your appId and appSecret. You can find them on the home page of the Symbl.ai platform.

![App ID](https://docs.symbl.ai/images/credentials-faf6f434.png)


### Environment variables
After you sign up on the Symbl.ai platform you copy your APP_ID and APP_SECRET, you need to set them up under `.env` file in this repo

```
APP_ID=
APP_SECRET=
```


## Deploying

To run app locally , add credentials to `next-config.js` file filling in `APP_ID` and `APP_SECRET` variables.

```javascript
module.exports = {
Expand All @@ -50,22 +50,42 @@ module.exports = {

run `yarn` or `npm install`. To run the app, use `yarn dev`

Relevant docs section:
App will start running at http://localhost:3000

- [Getting started with Symbl](https://docs.symbl.ai/#getting-started)
- [API overview using Postman](https://docs.symbl.ai/#postman)
- [Authentication](https://docs.symbl.ai/#authentication)
![](https://symbltestdata.s3.us-east-2.amazonaws.com/NeerajTest/Nextjs-Symbl-demo+Images/Nextjsphonecall.png)

How Tos are available [here](https://docs.symbl.ai/#how-tos)

In this app represented are the following
## Conclusion

In this app we have represented the following capabilities of Symbl.ai

- Symbl Node SDK (Check out `api/call` file)
- REST Telephony API (`/phone` page)
- Conversational API (`/conversations` page)
- Async Audio API (`/audio` page)
- Async Video API (`/video` page)
- Async Text API (`/text` page) - Comming soon
- Async Text API (`/text` page) - Coming soon
- Symbl react elements package available [here](https://www.npmjs.com/package/@symblai/react-elements)

## Enjoy hacking with Symbl and if you have new ideas in mind, feel free to clone the repo and contribute or submit an issue.
Relevant docs section:

- [Getting started with Symbl](https://docs.symbl.ai/#getting-started)
- [API overview using Postman](https://docs.symbl.ai/#postman)
- [Authentication](https://docs.symbl.ai/#authentication)

How Tos are available [here](https://docs.symbl.ai/#how-tos)


### Community

If you liked our integration guide, please star our repo!

If you have any questions, feel free to reach out to us at [email protected] or through our Community Slack at [https://developer.symbl.ai/community/slack](https://developer.symbl.ai/community/slack)

This library is released under the [MIT License][license]

[Signup for free](https://platform.symbl.ai)