Skip to content

Latest commit

 

History

History
140 lines (99 loc) · 9.03 KB

README.md

File metadata and controls

140 lines (99 loc) · 9.03 KB

Brainfock

Brainfock — Developer Readme

Copyright (C) 2015-present Sergii Gamaiunov <@SergiiGama>

Techniques

Prerequisites

Install node.js (v4 is required).

If you are using different node versions on your machine, use nvm to manage them.

You may also need to upgrade npm to 3.x

npm install -g [email protected]

Installation

Get code and setup required NPM packages:

git clone https://github.com/Brainfock/Brainfock.git brainfock
cd brainfock
npm install

Create a MySQL database and import src/branfock_install.sql.

Setup your data sources

Brainfock uses Loopback and is ready for environment-specific configurations out-of-the-box. Default datasources config can be found in src/server/datasources.json - you can modify that file (not recommended) or create local or environment configuration file. Create src/server/datasources.local.json file and copy contents of src/server/datasources.json to quickly create local configuration file. Restart Brainfock app to apply new config files.

Production setup

To complete Brainfock app setup for production, you need to set NODE_ENV=production and (optionally) set any of the following properties:

  • DB_HOST - database host address
  • DB_PORT - database port
  • DB_USER - database user
  • DB_PASSWORD - database password

Start Development

  • run npm run start-dev
  • point your browser to localhost:3000
  • build something beautiful

Dev Tasks

  • npm run start-dev run app in development mode
  • npm run web-build build web package
  • npm test test native, web & common

Prod Tasks

  • npm run start just run app, remember to set NODE_ENV=production and others environment variables.

Documentation

Choosing dev stack is a diligent process, but look no more! Brainfock uses great Este.js dev stack made by Daniel Steigerwald, twitter.com/steida, @grabbou and the community.

The most complete React/Flux dev stack and starter kit for universal functional web apps. Forget about evil frameworks, learn laser focused libraries and patterns instead.

Code is documentation itself as it illustrates various patterns, but for start you should read something about React.js. Then you should learn what is the Flux application architecture. Now refresh you JavaScript knowledge about "new" JavaScript - learn ES6. This stack uses immutable.js and class-less design for a good reason. Check this nice short video, wouldn't be possible with classic OOP classes everywhere approach. Functional programming is a next (current) big thing, read why. Loopback.io is used on the Node.js based server. Application is universal, so we can share code between browser, server, mobile, whatever easily. Congrats, you're Brainfock expert level 1 now :-)

Links

Windows

Use this if you are using JEST or another library, which has to be compiled.

  • Install Python - Install version 2.7 of Python and add it to your path or/and create a PYTHONPATH environment variable.
  • Install Visual Studio (Express Edition is fine) - We will need this for some of modules that are compiled when we are installing Brainfock. Download VS Express, get one of the versions that has C++ - Express 2013 for Windows Desktop for example.
  • Set Visual Studio Version Flags - We need to tell node-gyp (something that is used for compiling addons) what version of Visual Studio we want to compile with. You can do this either through an environment variable GYP_MSVS_VERSION. If you are using Express, you have to say GYP_MSVS_VERSION=2013e.

Thanks to Ryanlanciaux

Tips and Tricks

  • To check app state, press ctrl+shift+s, then open console.
  • With global app state, we don't need IoC container so badly - SOLID: the next step is Functional. Still DI is relevant for some cases and then use Pure DI.
  • Learn immutable.js, for example Seq. Handy even for native arrays and objects. For example, get object values: Seq(RoomType).toSet().toJS()
  • Even though we can use import {canUseDOM} from 'react/lib/ExecutionEnvironment' to detect browser/server, don't do it since it's runtime value. Use webpack DefinePlugin to set process.env.IS_BROWSER rather, because compilation removes dead code.
  • How to use Closure Tools, gist
  • Recommended editors are sublimetext and atom.io (tips).

FAQ

Why I am seeing warnings and errors when running npm install?

You can completely ignore them since they are coming from optional React Native dependencies as noted here. They will be gone with React Native 0.12 being released.

Why do I get EACCES error during npm install?

This indicates that you do not have permission to write to the directories that npm uses to store packages and commands. One possible solution is to change the permission to npm's default directory.

  1. Find the path to npm's directory: npm config get prefix For many systems, this will be /usr/local
  2. Change the owner of npm's directory's to the effective name of the current user
sudo chown -R `whoami` <directory>

Why does the CSS flicker when starting the app/refreshing it?

In dev mode, webpack loads all the style inline, which makes them hot reloadable. This behaviour disappears in production mode (NODE_ENV=production npm web-start).

Do you have any live example?

You bet! There is an official demo, check it out at http://brainfock.org.

Why Brainfock is pure and why we have to pass data through props?

Pure means no side effects. Programming without side effects rocks. It allows us to hot reload everything and testing is much easier as well. When component renders only data passed through props, shouldComponentUpdate can be implemented only once per whole app. One can say it's verbose, but it isn't. It's explicit. And remember, we have to pass only data going to be rendered. Actions have access to app state.

Notes

  • Brainfock dev stack works on OSX, Linux, and Windows.
  • As a rule of thumb, Brainfock supports all evergreen browsers plus last two pieces of IE.
  • Support Brainfock development via Bitcoin - 16oPNMcwhxEz3HMn6wkpa4HfnQUsTY6FKr