# Introduction

findoutnow.co.uk (opens new window) (FoN) is an insight platform making market research accessible and practical for businesses.

# Getting Started

FoN uses Vue.js (opens new window) in SPA mode and Vuex (opens new window) state management pattern as front-end solutions.

COMPATIBILITY NOTE

It requires Node.js (opens new window) >= 8.6

# Installation

# clone repo
git clone git@bitbucket.org:freepostcodelottery/findoutnow.git

# install dependecies
cd findoutnow/site && npm install

# prebuild files
npm run build

# install dependencies
composer install

# start dev server
npm run fon

# Directory Structure

findoutnow/            # → Your clone of this repository
├── cms/               # → WordPress
└── site/              
  ├── api/             # → API
  ├── build/
  ├── config/
  ├── docs/            # → VuePress (documentation)
  ├── public/          # → Static elements (won't be build)
  ├── src/             # → Front-End
    ├── assets
    ├── components
    ├── datas
    ├── filters
    ├── mixins
    ├── store
    ├── views
    └── ...   
  ├── vendor/
  ├── web/             # → Build
  └── ...   
└── trellis/

# Other Informations

Compiles and hot-reloads for development

npm run serve

Compiles and minifies for production

npm run build

Lints and fixes files

npm run lint

# Documentation

This documentation is powered by VuePress (opens new window).

# root
cd findoutnow/site/docs

# start dev server
npm run docs:dev

# build for production
npm run docs:build

# Deploying

# Staging (opens new window)

Build the project for production and sftp the /findoutnow/site/web folder into /srv/www/findoutnow.co.uk

WARNING

Do not remove the API folder

# root
cd findoutnow/site

# build for production
npm run build

# Production (opens new window)

Install and use Deployer (opens new window)

# installation
curl -LO https://deployer.org/deployer.phar
mv deployer.phar /usr/local/bin/dep
chmod +x /usr/local/bin/dep

# deploy to production
dep deploy production

# rollback to previous version
dep rollback production

Conventions →