Skip to content

Latest commit

 

History

History
271 lines (168 loc) · 9.13 KB

INSTALL.md

File metadata and controls

271 lines (168 loc) · 9.13 KB
Raw

TIBET™ -- The Desktop-to-Cloud Platform™

                                 ,`
                          __,~//`
       ,///,_       .~///////'`
           '//,   ///'`
              '/_/'
                `
        /////////////////     /////////////// ///
        `//'````````///      `//'```````````  '''
        ,/`          //      ,/'
       ,/___          /'    ,/_____
      ///////;;,_     //   ,/////////;,_
               `'//,  '/            `'///,_
                   `'/,/                '//,
                      `/,                  `/,
                        '                   `/
                                             '/
                                              /
                                              '

For TIBET documentation see https://technicalpursuit.com.


Installation

Installation

For Node/JS development on Mac OS, Linux, or Windows install via npm.

See installing via Docker to use one of our pre-built TIBET Docker images.

To install a Git fork see the TIBET Git Installation instructions.


Install via npm

Installing TIBET via npm:

If you are missing any of TIBET's node/npm prerequisites install those by following the instructions in the prerequisites section of this guide.

TIBET is currently installed globally using npm install -g: 

npm install -g tibet

Initial installation can take several minutes depending on the speed of your network connection and the particular version being installed. Be patient. TIBET includes a full client stack, a full server stack, and a full tool chain. It's worth the wait :).

Once the npm install process is complete, execute:

tibet init

Upon completion you'll be directed to the TIBET Quickstart Guide to get started.

Install via Docker

Installing TIBET via Docker:

TIBET Docker images exist on DockerHub and are prebuilt for ease of development.

Ensure you have Docker installed

To get started with TIBET and Docker you'll need Docker software for your machine.

To install Docker follow the install instructions found in the Docker Documentation.

Install a TIBET Docker image

Next, install the TIBET Docker image by pulling it from Dockerhub:

docker pull technicalpursuit/tibet

The above command will pull the latest TIBET release (by default docker pull will pull the image with the :latest tag). The following command is equivalent:

docker pull technicalpursuit/tibet:latest

TIBET follows a 'semver' versioning scheme which allows you to pull specific versions using commands similar to the following:

docker pull technicalpursuit/tibet:5

docker pull technicalpursuit/tibet:5.0

docker pull technicalpursuit/tibet:5.0.0
Instantiate a TIBET-imaged container

Create a Docker container and execute it by running the TIBET Docker image.

Note that port 1407 (the registered TIBET Data Server port) is exposed inside the container by default. To execute the environment and expose the port into your host environment, execute the following:

docker run -i -p 127.0.0.1:1407:1407/tcp -t technicalpursuit/tibet

You are now inside of the Docker environment, inside of the home directory of the 'developer' user that the TIBET Docker image created for you, ready to start TIBET development!

After you create your TIBET project and build it (see instructions later on how to do that), you can access the TIBET Data Server running in your Docker container by going to this address in a browser in your host environment:

http://127.0.0.01:1407

NOTE Be aware that Docker does NOT preserve the environment after you exit the container (by executing exit from the shell). Any work you've done in the container will be lost!!! Therefore, you need to use Docker to either mount a volume or use bind mounts to persist your TIBET project. Follow the instructions at Docker Volumes and Docker Bind Mounts.


Install via Git

Installing TIBET via Git:

If you prefer working from a git repository you can install TIBET via git. This approach can take a fair amount of time depending on connection and machine speed since you'll need to download all of TIBET's dependencies and build them locally.

Check TIBET's prerequisites first.

Next, check TIBET's supported platform chart for your target platform(s).

NOTE: Be sure to uninstall any npm-installed version of TIBET. If you have already installed TIBET via npm you need to first remove that installation to avoid conflicts with your Git-based installation:

npm uninstall -g tibet
Create a Fork

If you are going to install TIBET via Git we recommend that you first create a fork of TIBET so you can manage updates in a stable, predictable fashion.

Follow these instructions to create your own fork.

Clone your Fork
git clone {{your_fork_repo_url}}
Initialize your Fork

Once your fork has been cloned move into the new fork directory and install the package dependencies:

cd {{your_fork_repo_directory}}
npm install .
Link TIBET via npm

With your fork initialized you'll need to link the repository via npm link so that the tibet command will function. From the top of your TIBET fork type:

npm link .

You should now be able to use the `tibet` command which lets you run `tibet build`.
Build TIBET Dependencies and Packages

When working with a git-based repository you'll need to rebuild TIBET packages and dependencies, depending on your individual project launch configuration.

To build the full set of TIBET dependencies and launch packages use:

tibet build_all

NOTE: the above command can take quite some time depending on your network connection, machine performance, etc. since it's building a large set of dependent modules in addition to TIBET itself.

With TIBET cloned, initialized, linked, and built you're ready to rock.


Supported Platforms

TIBET CLI / Server

The TIBET CLI, TIBET Data Server (TDS), and TIBET Workflow System (TWS) run on supported NodeJS platforms including Windows, Mac OS, and common Linux variants.

TIBET Client / Lama

Platform Runtime Zero Reload Lama
Electron ^12.x Yes Yes Preview
Google Chrome ^89 Yes Yes Preview
Microsoft Edge (Chromium) ^89 Yes Yes No
Mozilla Firefox ^87 Yes Yes No
Apple Safari ^14 Yes Yes No
Microsoft Edge (Legacy) No No No
Microsoft IE No No No

Prerequisites

Prerequisites

Install Node.js

TIBET requires Node.js version 12+ for proper operation.

We also recommend using npm version 6.x or higher.

You can confirm your node, and npm versions using:

node --version
v12.18.1

npm --version
6.14.5

We strongly recommend you use the Node Version Manager (nvm) to manage your Node.js installation. Using nvm lets you install multiple versions of Node.js and switch between them with ease which is great for development and helpful if you need to adjust the version running in production while maintaining an easy rollback strategy.

To install Node.js via nvm see the instructions at the nvm GitHub repo.

To install Node.js without nvm follow the instructions at nodejs.org.

Update/Adjust npm

If you already have a recent version of Node.js installed you should have a valid version of npm. We suggest using at least npm 5.x.

If you see errors from any npm-based operations mentioning cb() never called! you'll want to perform the appropriate steps for your operating system. See this npm troubleshooting topic for more.


The Pup

Visit https://www.technicalpursuit.com for more information.