Click here to visit the app.
Educational content is lost from zoom during remote calls that could be saved and reused. What if we could transcribe and save all student/attendee questions and notes during online lectures/brown bags?
Our goal is to create an app that works in sync with Zoom calls to fix an internal problem at Lambda School - Content is lost from Zoom calls that could be saved and reused from each cohort. What if we could transcribe and save all student questions during lecture and brown bags? Our goal is to give back to Lambda with our labs project by creating an app that takes content creation to a whole new level. Questions are no longer lost during lecture - each question is timestamped (when answered) for transcription. Instructors can choose to answer or punt questions. The major feature of our app is recording and pushing zoom calls directly to Youtube, transcribing the calls and pushing transcribed information to a GitHub Wiki page (in this case, it would be a test repo until permissions were granted to update the Lambda School wiki). This allows every lambda lecture to be searchable based on transcription results, editable by students and open source for all cohorts to come.
Technology stack: MongodB Express React NodeJS
Links to production or demo instances: Server - https://teamcomm2.herokuapp.com Client - https://team-comm.netlify.com/ Staging - https://staging--team-comm.netlify.com/
-
Make sure that you have Node.js v10.13.0 installed.
-
Clone this repo using
git clone https://github.com/Lambda-School-Labs/Labs8-TeamComms.git -
Move to the front-end directory: cd Labs8-TeamComms
-
Run
yarn installto install front-end dependencies. -
Move to the server directory: cd server
-
Run
yarn installto install server dependencies.
IMPORTANT: You will need to make a .env file in the base repo directory with your own environment variables setup...here are the current environment variables you will need to generate:
SECRET_KEY="your secret key"
SKIP_PREFLIGHT_CHECK=true
MONGOLAB_URL="mongodb://your hosted mongodb url"
CLIENT_ID="google client id"
CLIENT_SECRET="google client secret"
STRIPE_PLAN_ID=stripeplanid
STRIPE_SECRET_KEY=stripesecretkey
ZOOM_KEY = "zoomkey"
ZOOM_SECRET = "zoomsecret"
SENDGRID_KEY = "sendgridkey"
In the base project directory, you can run:
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
In the server directory, you can run:
Runs the server in development mode.
Open http://localhost:3300 to view it in the browser.
Register a User if the username does not already exist. Usernames must be unique.
URL : https://teamcomm2.herokuapp.com/api/users/register
Method : POST
Data example All fields must be sent.
{
*Required
"username": "jerry",
"password": "password123",
"phone_number": 1234567890,
"email": "testemail@email.com",
*Optional
"organization": "Organization LLC",
"premium": false
}Condition : If everything is OK and a User didn't exist.
Code : 200
Content example 👍
{
"token": 123aBc456DfG123aBc456DfG123aBc456DfG123aBc456DfG123aBc456DfG,
"user": {
"username": "jerry",
"email": "testemail@email.com",
"phone_number": 1234567890,
"organization": "Organization LLC",
"premium": false,
"is_active": true
}
Condition : If fields are missed.
Code : 400 BAD REQUEST
Login a User and returns a token for User.
URL : https://teamcomm2.herokuapp.com/api/users/login
Method : POST
Data example All fields must be sent.
{
"username": "jerry",
"password": "password123"
}Condition : If everything is OK and a User didn't exist.
Code : 200
Content example 👍
{
"token": 123aBc456DfG123aBc456DfG123aBc456DfG123aBc456DfG123aBc456DfG,
"user": {
"username": "jerry",
"email": "testemail@email.com",
"phone_number": 1234567890,
"organization": "Organization LLC",
"premium": false,
"is_active": true
}
Condition : If 'username' and 'password' combination is wrong.
Code : 401
Update a User if a User is logged in and authenticated with token.
URL : https://teamcomm2.herokuapp.com/api/users/edit
Method : PUT
Data example All fields are optional.
{
"username": "jerry",
"password": "password123",
"phone_number": 1234567890,
"email": "testemail@email.com",
"organization": "Organization LLC",
"is_active": true
}Header : Pass token in header with a key of "auth"
Condition : If user is authenticated and everything is updated successfully.
Code : 200
Content example 👍
{
"user": {
"username": "jerry",
"email": "testemail@email.com",
"phone_number": 1234567890,
"organization": "Organization LLC",
"premium": false,
"is_active": true
}
Condition : If error updating or authenticating User.
Code : 401
To delete a User, use the above Edit User endpoint and change active: false.
https://medium.com/zoom-developer-blog/using-zoom-apis-version-2-with-postman-3fba79dcdf2e
https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingcreate
Create zoom jwt token online https://jwt.io/
https://developer.zoom.us/blog/a-brief-look-at-zoom-account-structures/
https://zoom.github.io/api/?shell#introduction
https://developer.zoom.us/docs/webhooks/
https://github.com/zoom/data-visualization-sample-app
Please see the open issues in our issue tracker. If you have questions, concerns, bug reports, etc, please file an issue. Our Issue Tracker
Love Team Communicator and want to help? Thanks so much, there's something to do for everybody!
Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.
A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!
Guidelines for bug reports:
-
Use the GitHub issue search — check if the issue has already been reported.
-
Check if the issue has been fixed — try to reproduce it using the latest
masteror development branch in the repository. -
Isolate the problem — ideally create a reduced test case and a live example.
A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? What would you expect to be the outcome? All these details will help people to fix any potential bugs.
Example:
Short and descriptive example bug report title
A summary of the issue and the browser/OS environment in which it occurs. If suitable, include the steps required to reproduce the bug.
- This is the first step
- This is the second step
- Further steps, etc.
<url>- a link to the reduced test caseAny other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).
Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.
Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code, porting to a different language), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.
Please adhere to the coding conventions used throughout a project (indentation, accurate comments, etc.) and any other requirements (such as test coverage).
Since the master branch is what people actually use in production, we have a
dev branch that unstable changes get merged into first. Only when we
consider that stable we merge it into the master branch and release the
changes for real.
Adhering to the following process is the best way to get your work included in the project:
-
Fork the project, clone your fork, and configure the remotes:
# Clone your fork of the repo into the current directory git clone https://github.com/<your-username>/Labs8-TeamComms.git # Navigate to the newly cloned directory cd Labs8-TeamComms # Assign the original repo to a remote called "upstream" git remote add upstream https://github.com/<your-username>/Labs8-TeamComms.git
-
If you cloned a while ago, get the latest changes from upstream:
git checkout dev git pull upstream dev
-
Create a new topic branch (off the
devbranch) to contain your feature, change, or fix:git checkout -b <topic-branch-name>
-
Commit your changes in logical chunks. Please adhere to these git commit message guidelines or your code is unlikely be merged into the main project. Use Git's interactive rebase feature to tidy up your commits before making them public.
-
Locally merge (or rebase) the upstream dev branch into your topic branch:
git pull [--rebase] upstream dev
-
Push your topic branch up to your fork:
git push origin <topic-branch-name>
-
Open a Pull Request with a clear title and description.
IMPORTANT: By submitting a patch, you agree to allow the project owners to license your work under the terms of the MIT License.
There are few basic rules to ensure high quality of the repo:
- Before merging, a PR requires at least two approvals from the collaborators unless it's an architectural change, a large feature, etc. If it is, then at least 50% of the core team have to agree to merge it, with every team member having a full veto right. (i.e. every single one can block any PR)
- A PR should remain open for at least two days before merging (does not apply for trivial contributions like fixing a typo). This way everyone has enough time to look into it.
You are always welcome to discuss and propose improvements to this guideline.