Permalink
Browse files

Updated development env guide

  • Loading branch information...
davidmerfield committed Jan 8, 2019
1 parent 038e351 commit 47b695755983439f4e8d55147f042ce9cd4e69bd
Showing with 14 additions and 10 deletions.
  1. +14 −10 config/guides/development-environment.md
@@ -10,38 +10,42 @@ This is a short guide to installing Blot on your machine. I develop Blot on OSX
- [npm](https://www.npmjs.com) (use version ```6.4.1```, installed using nvm)
- [redis](https://redis.io/) - Read the [installation guide](http://jasdeep.ca/2012/05/installing-redis-on-mac-os-x/)

## Getting the code
## Installing Blot

Clone the git repository containing Blot's source code (700mb, sorry!):
**Get the code** by cloning the git repository (700mb, sorry!):

```
git clone https://github.com/davidmerfield/Blot
```

## Installing dependencies

Move into the repo's root directory and install all some of Blot's dependencies using npm:
**Install the depencies** once you're into the repo's root directory:

```
cd Blot
npm install
```

## Environment variables

Fill out and then source the environment variables in environment.dev.sh
**Export environment variables** needed by Blot:

```
export BLOT_HOST=localhost
export BLOT_CACHE_DIRECTORY=~/Projects/testblot/Blot/data/cache
export BLOT_SESSION_SECRET=abc
```

Download and install redis. Start a redis server using the redis.conf file in /config
Start a redis server using the redis.conf file in /config

```
redis-server config/redis.conf
```

## Running the Blot server

Run the node.js application like this:
Start the node.js application like this:

```
node app
```

## Creating a test account

0 comments on commit 47b6957

Please sign in to comment.