Skip to content

fossasia/susi.ai

Repository files navigation

logo

SUSI.AI Web Application

Weblate Codacy Badge Build Status Gitter Twitter Follow


SUSI.AI is an artificial intelligence system, combining pattern matching, internet data, data flow, and inference engine principles. Through some abilities to reflect, it can remember the user input to produce deductions and personalized feedback. Its purpose is to explore the abilities of an artificial companion and to answer the remaining unanswered questions. The SUSI.AI web is a front-end developed for web access of SUSI.

Communication

Please join our mailing list to discuss questions regarding the project: https://groups.google.com/group/susiai/

Our chat channel is to be found on Gitter: https://gitter.im/fossasia/susi_webchat

Technology Stack

Components

  • CSS: Styling web pages, html files
  • Javascript: Primary programing language
  • ReactJS: Javascript library for building User Interfaces
  • Redux: Managing global state
  • Material-UI: UI library for design system
  • styled-components: CSS-in-JS library

Development

SUSI.AI is written in JavaScript with React. To get started with the code, follow this doc:

Requirements

  • node --version >= 6
  • yarn --version >= 3

Local Installation

Steps

  • git clone <repository-url> , where <repository-url> is the link to the forked repository
  • cd susi.ai

Note : If you want to contribute, first fork the original repository and clone the forked repository into your local machine followed by cd into the directory

git clone https://github.com/USERNAME/susi.ai.git
cd susi.ai
  • Install all the dependencies with yarn install
  • Start the server with yarn start
  • Visit your app at http://localhost:3000.

Installation with docker

Steps

  • git clone <repository-url>, where <respository-url> is link to the forked repository
  • cd susi.ai
git clone https://github.com/USERNAME/susi.ai.git
cd susi.ai
docker build --tag susi.ai:1.0 .
docker run -p 3000:3000 -d susi.ai:1.0

How to deploy?

Click Here to read how to deploy

Translations

Add translations in new language for SUSI.AI Web

License

This repository is under a GNU LESSER GENERAL PUBLIC LICENSE 2.1.