Skip to content

Latest commit

 

History

History
63 lines (52 loc) · 2.59 KB

setup.md

File metadata and controls

63 lines (52 loc) · 2.59 KB

macOS Setup

Firstly, you'll need to install some developer tools to get Cryb setup on macOS.

Docs

Using Terminal

You'll want to use Terminal.app, which is pre-installed on all macOS installations by default. You can find Terminal under Appications/Utilities/Terminal.app.

Here you'll run all the commands needed to setup Cryb.

Footnotes

  • If you want to use a terminal emulator, such as iTerm or Hyper, then go ahead!

Tools Needed

  • Homebrew
    • Recommended
    • Used for installing required packages
    • Install
  • Node.js Runtime
    • Required
    • Used as the runtime for all major Cryb deployments.
    • Install
  • Yarn
    • Recommended Required
    • Used instead of npm for running deployments and installing packages.
    • Install
    • If you installed Homebrew, you can run brew install yarn to install Yarn
  • MongoDB
    • Required
    • Used as the primary datastore for @cryb/api, @cryb/portals and @cryb/aperture
    • Install
    • If you installed Homebrew, you can simply run the following commands to install MongoDB:
      • brew tap mongodb/brew
      • brew install mongodb-community@4.2
    • You may also want to install a MongoDB GUI, such as Robo 3T or MongoDB Compass to make it easier to view and edit data inside of your MongoDB server
  • Redis
    • Required
    • Used as the primary cache and pub/sub for @cryb/api and @cryb/portals
    • Install
    • If you installed Homebrew, you can run brew install redis to install Redis
    • You may also want to install a Redis GUi such as Medis to view or edit data and run commands on your Redis server

Setting up the folder structure

Now we have the tools we need installed, we'll setup our folder structure. First of all, open up your Terminal. Now, type the following and hit enter:

mkdir cryb

This creates a folder called cryb in our home folder. Now, we'll want to enter that folder. Type the following and hit enter:

cd cryb

Now we're in the cryb directory, and we're ready to continue onto the next step.

Next step

Next we'll setup @cryb/api: Setting up API.