Network-Map

table of contents

• start
• design
• stack
• folder structure
• scripts
  • npm start
  • npm run dev
  • TODO npm test
  • npm run lint
  • npm run sql
• notes

start

before you start, please

• install node@8 and npm@5
• install git-lfs
• install and set up Postgres for your system
• create a database in Postgres named yipalumni_development (see Postgres DEV setup)
• install Redis

git clone https://github.com/YIP-Alumni-Map/Network-Map.git
cd Network-Map
npm install
npm run sql migrate:latest
npm run sql seed:run
npm run dev

design

ux

• join

  • land
  • login email
  • home page

  ---

  Landing (route === /) !userIsAuthenticated ? Component = Welcome + Send Login Email : !userIsOnboarded ? Component = Onboarding : Component = Home

  ---

  Profile

data models

• users
  • id
  • name
  • email

architecture

• asset server (netlify)
• web server (heroku)
• mailer worker (heroku)

stack

• web server

  • @feathersjs/socketio
  • @feathersjs/authentication
  • @feathersjs/authentication-jwt
  • node-resque

• web app

  • next.js
  • ramda
  • @feathersjs/socketio-client
  • @feathersjs/authentication-client
  • react
  • react-hyperscript
  • recompose
  • fela
  • material-ui

• mailer worker

  • node-resque
  • nodemailer
  • third-party: mailgun
  • dev tool: maildev

folder structure

we're following the dogstack folder structure convention, adapted for our stack.

available scripts

npm start

starts production server

npm start

npm run dev

starts development server

npm run dev

TODO npm test

runs ava tests

Can optionally take a glob

npm test -- './todos/**/*.test.js'

Default glob is ./**/*.test.js ignoring node_modules

npm run lint

checks for standard style

can optionally take a glob

npm run lint -- './todos/**/*.js'

default glob is ./**/*.js ignoring node_modules

npm run sql

runs knex command, with any arguments.

npm run sql migrate:latest

npm run sql seed:run

notes

After deploy: migrate on heroku!

heroku login
heroku run npm run sql migrate:latest --app=yip-network

Postgres DEV setup

use a ~/.pgpass file to automate your passwords!

echo "localhost:5432:*:postgres:password" > ~/.pgpass
chmod 600 ~/.pgpass

create your database with:

createdb yipalumni_development -h localhost -U postgres

drop your database with:

dropdb yipalumni_development -h localhost -U postgres

connect to your database with:

psql -h localhost -U postgres -d yipalumni_development

emoji

• https://afeld.github.io/emoji-css/

license

AGPL-3.0

attributions

• Emoji artwork is provided by Twemoji and is licensed under CC-BY 4.0