Skip to content

Themisto/CrossTalk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

331 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CrossTalk

Summary

CrossTalk is the app that connects users looking to learn a new language in an interactive and social way! The hardest part about learning a new language is finding someone to talk to. Simply signup and tell us what language you're interested in learning, then we'll handle the rest. CrossTalk will match you up with another user who speaks that language, and is also interested in learning your native language.

Meet Team Themisto

Table of Contents

  1. Requirements
  2. Technologies Used
  3. API Usage
  4. Development
    1. Installing Dependencies
  5. Contributing
    1. Roadmap

Requirements

  • Node 7.x

Technologies Used

  • Server Side
    • Express - server framework
    • Socket.IO - signaling server
  • Client Side
    • Google Chrome Speech-To-Text - speech-to-text
    • Socket.IO - server communication
    • Vue - frontend framework
    • WebRTC - media stream and user connection management
  • External APIs
    • Microsoft Cognitive Services - language translation

API Usage

Login & Signup

  • POST /api/signup

Add and authenticate a new user. Pass the user's name and password in the body of the request:

{
  "username": "Robin Kim",
  "password": "secretsecretsecret"
}

Will return a valid JSON web token (JWT) string for use in other requests. Token payload contains the user's ID and username (under the sub and user keys, respectively). See JWT.io for more information.

To make requests to protected endpoints using a token, prepend the word "Bearer" to the token string and pass under the x-access-token header.

e.g. x-access-token:Bearer your.token.string

Note: tokens will expire after 7 days.

Development

Installing Dependencies

Contributing

See CONTRIBUTING.md for contribution guidelines.

Roadmap

View the project roadmap here

About

No description, website, or topics provided.

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •