Skip to content

tutorcruncher/socket-frontend

Repository files navigation

TutorCruncher Socket frontend

Build Status codecov netlify

Javascript application for TutorCruncher's web integration.

How to use

Simply call Socket on your own website; your own CSS and other styling applies.

It defaults to use the TutorCruncher Socket backend, but you can use your own if you like.

Alternatively, you can just use TutorCruncher's API and build your own frontend.

Help Article.

Setup and Run locally

To set up and run this project, follow these steps:

  1. Install dependencies:

     nvm install 14
     nvm use 14
     yarn install
  2. Run the application:

     yarn start
  3. Set the environment variables:

     REACT_APP_SOCKET_API_URL='http://localhost:8000'
  4. Set the company public api key:

    in public/index.html set public_key with the company's public api key

    • dino tutors is = 9c79f14df986a1ec693c
  5. Set api root:

    in public/index.html set api_root to the root of the api

    • for local testing it is http://localhost:8000
    • to use socket-beta it is https://socket-beta.tutorcruncher.com