Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 2.57 KB

README.md

File metadata and controls

37 lines (23 loc) · 2.57 KB
Raw

Langsnap

Introduction

Say hello to the world with Langsnap! Our easy to use app will help improve your language skills in a fun and easy way. By registering your details with us you will gain access to tools that help track your progress, save the words which you have learned and test the level of your understanding. Langsnap is optimised to run on all major mobile devices, making it accessible to all. Go to https://langsnap.netlify.app/ and learn a new skill today!

Motivation

This application was built by Alex Carrie, Ethan Moss, Petru Stanescu and Tim Doolan, as part of the group project phase of the Northcoders software developer course.

Requirements

In order to run this application from your terminal on your local machine, please ensure that you have installed the latest version of Node.js (version 12.16 or higher).

Running the project on your local machine

Firstly, please clone this project by using the command git clone https://github.com/petruS92/Langsnap-FE. You must then access the folder, using the command cd Langsnap-FE and install the required dependencies for the applciation to work using the command npm install. To launch the project itself use npm start which will then open in your browser.

If you wish to visit the deployed version of this website, please visit: https://langsnap.netlify.app/.

Langsnap API

A hosted version of the back-end API which works with this front-end project, can be found at https://langsnap-be.herokuapp.com/api. This will also display all the available endpoints which the API can serve as well as the format of the requests. The repo for the code of the back-end API is found at https://github.com/tim0git/Langsnap-BE.git.

Frameworks used in the project

The following frameworks and libraries were used in this project:

  • Axios - HTTP client;
  • React.js - library used to build the web interface;
  • Jest.js - testing framework used for front-end development;
  • TensorFlow.js - machine learning library;
  • MobileNetV2 - pre-trained model used in conjuction with TensorFlow.js to detect and classify objects;
  • Express.js - web framework for Node.js;
  • Firebase - database and authentication services;
  • Mocha - Javascript test used for back-end code;
  • Chai.js - TDD assertion library used in conjunction with Mocha for back-end development;