Skip to content

BrainBackup/bb8

Repository files navigation

BB8: modular, powerful and extendable project for memory improvment

brain-backup


License: MIT CI Docker Images Creation Auth-service NPM packages Text-service

Overview

  • Provide users an ability to save code snippets, highlighted data from anywhere on the web.
  • Code snippets will be provided once the user starts typing in an IDE, searching, and analytics using a web application.
  • The users will be able to add data using chrome-extension, keyboard shortcut, right-click and simple user interface.

Simple development process

local development using docker

docker-compose build

docker-compose up

  • process.env.NODE_ENV - development, test and production - should be passed as env variable

Authentication service

  • Require mysql: cd mysql && docker-compose up
  • Running locally: cd auth-service && yarn start:dev
  • Swagger: go to http://localhost:3010/api/
  • Health check: http://localhost:3010/health

Text service

  • Require elastic: cd elastic && docker-compose up
  • Running locally: cd text-service && yarn start:dev
  • Swagger: go to http://localhost:3009/api/
  • Health check: http://localhost:3009/health

Chrome extension

  • Side loading the chrome extension: go to chrome://extensions, click on Load unpacked, select the chrome-extension directoy
  • Open issue: the header should include chrome-extension:: and follow up the subject of the issue.
  • TODO: Automatic way to update the app.

Test NLP service

  • MLQA reserch from Facebook® should be a good start.