booben

(โ˜… 106)

Web app constructor based on React, with GraphQL bindings

  • .dockerignore
  • .editorconfig
  • .eslintignore
  • .eslintrc
  • .gitignore
  • .prettierrc.json
  • .travis.yml
  • bootstrap.sh
  • config.js
  • dev-config.json
  • docker-compose.yml
  • index.js
  • LICENSE
  • Makefile
  • package-lock.json
  • package.json
  • README.md
  • rebuild-components-bundle.js

# Installation Guide

1. Get the code
git clone https://github.com/bcrumbs/booben

Downloads the entire project code from GitHub to your computer.

cd booben

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 pull braincrumbs/booben

Type this command into your terminal and run it.

docker run -d --name=booben -p 3000:3000 braincrumbs/booben

Runs the built image as an actual container.

docker-compose pull

Runs the command against the services defined in the compose file.

docker-compose up -d

Runs the command against the services defined in the compose file.

โœ… 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.

4. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make bootstrap

Compiles the code based on the generated build configuration to produce an executable.

โœ… If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation