README_DEV.md

a-count – developer edition

here are some of the commands to run the project locally

• universal application flow
• requirements
• dev stack
  • acount-api
  • acount-nuxt
  • acount-react
• commands
  • building dependencies
  • production server
  • development server
  • running the server and the app in 2 different terminals
  • tests

universal application flow

the application flow is explained in this blog post

requirements

• node >= 8.11.3
• yarn >= 1.7.0
  • on a mac brew install yarn --without-node
• PostgreSQL >=9.6
  • create a clean a-count database
  • postgresapp on a mac
  • postico to visualize
• Redis >= 3.2.0
  • on a mac brew install redis → redis-server to start
• SMTP server
  • like mailcatcher
    on a mac brew install ruby → restart terminal → gem install mailcatcher → mailcatcher to start
  • or MailDev

dev stack

acount-api

• server – Koa 2 for having a cleaner use of async/await in comparison to express.js
• database querying
  • Sequelize 4 for the main parts
  • Squel for handling SQL queries creation when the sequelize API can't get it (mostly COUNT & SUM queries)

acount-nuxt

⚠️ work in progress

• views – Vue 2
• router – Vue router
• application state – Vuex
• server – Koa 2

acount-react

⚠️ deprecated

⚠️ in order to function needs

{
  "react-router": "4.3.1",
  "react-router-config": "1.0.0-beta.4"
}

• views – React 16
• router
  • React router 4
  • react-router-config 1 for the universal support
• application state
  • redux 4
  • redux thunk for a better handling of asynchronous actions
  • react redux for a better integration with React
• server – Koa 2
• build tools & testing
  • Babel 7 – still in beta but already working great
  • Webpack 4
  • Ava 1 – still in beta also –_–' waiting for Babel 7 to get out of beta for getting out ^^

commands

building dependencies

yarn install

production server

yarn build && yarn start

development server

yarn dev

add some debug (with node debuglog):

NODE_DEBUG=api,api:db,server yarn dev

available:

• api
• api:redis
• api:db
• api:db:query
• api:mailing
• server

running the server and the app in 2 different terminals

For the API:

yarn workspace acount-api dev

For the Vue web-app:

yarn workspace acount-nuxt dev

For the React web-app:

yarn workspace acount-react dev

tests

all workspace implements test

yarn workspace acount-api test
yarn workspace acount-nuxt test
yarn workspace acount-react test

running a single test

yarn test shared/ui/field.spec.js