|
| 1 | +# Using Development and Debug Versions |
| 2 | + |
| 3 | +You might need to run Exoframe CLI and Server in development mode. |
| 4 | +There is currently three ways to do so. |
| 5 | +They are described in more detail below. |
| 6 | + |
| 7 | +## Using development versions from source |
| 8 | + |
| 9 | +Primary way of running Exoframe CLI and Server in development mode is by using source code available in github. |
| 10 | + |
| 11 | +### Exoframe CLI |
| 12 | + |
| 13 | +Exoframe CLI requires you to have Node.js and yarn installed. |
| 14 | +To run Exoframe CLI in development follow this steps: |
| 15 | + |
| 16 | +1. Make sure you don't have `exoframe` installed globally - if you do, remove it |
| 17 | +2. Clone the Exoframe CLI repo: `git clone git@github.com:exoframejs/exoframe.git && cd exoframe` |
| 18 | +3. Install dependencies: `yarn install` |
| 19 | +4. Link Exoframe CLI to your global packages to expose it as a command: `npm link` |
| 20 | +5. You can now run `exoframe --version` which should execute your dev version of Exoframe CLI |
| 21 | + |
| 22 | +### Exoframe-Server |
| 23 | + |
| 24 | +Exoframe-Server requires you to have Node.js, yarn, Docker and docker-compose installed. |
| 25 | +To run Exoframe-Server in development follow this steps: |
| 26 | + |
| 27 | +1. Clone the Exoframe-Server repo: `git clone git@github.com:exoframejs/exoframe-server.git && cd exoframe-server` |
| 28 | +2. Install dependencies: `yarn install` |
| 29 | +3. You can now run the server by executing: `yarn start` |
| 30 | +4. Point your Exoframe CLI to `http://localhost:8080` to access your server |
| 31 | + |
| 32 | +## Using Exoframe-Server debug version from npm |
| 33 | + |
| 34 | +It is also possible to run Exoframe-Server in development mode by using package available in npm. |
| 35 | +Exoframe-Server can be installed by running `npm install -g exoframe-server`. |
| 36 | +This will add `exoframe-server` binary to your system - executing it will start Exoframe-Server in development mode. |
| 37 | +This way also requires you to have Node.js, yarn, Docker and docker-compose installed. |
| 38 | + |
| 39 | +## Using Exoframe-Server debug version from docker hub |
| 40 | + |
| 41 | +It is also possible to run Exoframe-Server in development mode by using docker image available in docker hub. |
| 42 | +Exoframe-Server can be started by running `docker run -v ... exoframe/server:debug` (see [readme](../README.md) for full command). |
| 43 | +This will start Exoframe-Server in development mode. |
| 44 | +This way requires you to have Docker installed. |
0 commit comments