susi.ai

(โ˜… 2,069)

SUSI.AI Web Client https://susi.ai

  • .babelrc
  • .editorconfig
  • .env
  • .eslintrc
  • .gitignore
  • .nvmrc
  • .prettierrc
  • .travis.yml
  • deploy.sh
  • deploy_key.enc
  • Dockerfile
  • LICENSE
  • package.json
  • README.md
  • surge_deploy.sh
  • webpack.config.development.js
  • webpack.config.js
  • webpack.config.production.js
  • yarn.lock

๐Ÿš€ Installation Guide

1. Get the code
git clone https://github.com/fossasia/susi.ai

Downloads the entire project code from GitHub to your computer.

cd susi.ai

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build --tag susi.ai:1.0 .

Builds a runnable image based on the Dockerfile.

docker run -p 3000:3000 -d susi.ai:1.0

Runs the built image as an actual container.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
// repository documentation