DEPRECATED: This repository together with others has been merged into the orbiting/backends monorepo. Let's continue the journey there.

[DEPRECATED] Republik Backend

This is the successor to crowdfunding-backend and still under heavy development.

Depends on modules from: backend-modules

Usage

Quick start

You need to have node (8.3.0+) installed, postgres and redis running somewhere.

Boostrap your .env file.

PORT=3020
PUBLIC_URL=http://localhost:3020

# websocket URL and path
PUBLIC_WS_URL_BASE=ws://localhost:3020
PUBLIC_WS_URL_PATH=/graphql

SESSION_SECRET=replaceMe

# your frontend
CORS_WHITELIST_URL=http://localhost:3005
FRONTEND_BASE_URL=http://localhost:3005

# don't use the crowdfunding-backend DB directly! (read below)
DATABASE_URL=postgres://postgres@localhost:5432/republik

SEND_MAILS=true  # or false if you don't have mandrill at hand
MANDRILL_API_KEY=replaceMe
DEFAULT_MAIL_FROM_NAME='discussion'
DEFAULT_MAIL_FROM_ADDRESS='[email protected]'
QUESTIONS_MAIL_FROM_ADDRESS=
[email protected]
DISPLAY_AUTHOR_SECRET=replaceMe

# leave blank for default: 127.0.0.1:6379
REDIS_URL=

# start the asset server locally, handy for development
# provide the value of PUBLIC_URL to ASSETS_SERVER_BASE_URL
# check the README of assets-backend for which env vars you need to add to run
# the assets server locally.
LOCAL_ASSETS_SERVER=true
# base url of the asssets server. Set to local if you use LOCAL_ASSETS_SERVER
ASSETS_SERVER_BASE_URL=http://localhost:3020
# min 32bit key to authenticate the public the access the asset proxy
# you need to provide this regardless of LOCAL_ASSETS_SERVER
ASSETS_HMAC_KEY=
# url of where the assets uploaded to S3 will be avilable publictly
# NOTE: this going to be obsolete soon, when the assets server if going
# to serve resized images from S3
#ASSETS_BASE_URL=https://assets.staging.republik.ch

# despite using a local or remote assets server, this backend still uploads images
# to S3 directly, so you need this keys
AWS_REGION=eu-central-1
AWS_S3_BUCKET=republik-assets-staging
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=

# Sheet IDs for gsheets powered pages
GSHEETS={"someSheetId": "faqs","someSheetId": "updates","someSheetId": "events"}

# repoId for the preview mail (must be published)
PREVIEW_MAIL_REPO_ID=republik/newsletter-preview

Install dependencies.

yarn install

DB

To begin from a fresh DB, some more manual steps are required. We hope to improve the initial setup of this repo in the future. First checkout crowdfunding-backend and follow it's quicksteps to initialize the DB and seed it. After that's done follow the steps below.

If you are migrating from crowdfunding-backend:

Copy the /postgres to /republik to not touch the local crowdfunding db. This script will not work on heroku obviously.

node script/launch/copy_CF_DB.js [YOUR_PG_USERNAME]

psql postgres://YOUR_PG_USERNAME@localhost:5432/republik -c "ALTER TYPE \"paymentType\" ADD VALUE IF NOT EXISTS 'MEMBERSHIP_PERIOD' AFTER 'PLEDGE'"
yarn run launch

yarn run launch does the following:

• migrates the DB to match republik-backends expectations (yarn run db:migrate:up)
• activates memberships and generates membershipPeriods node script/launch/activateMemberships.js
• inserts the LAUNCH crowdfunding with the monthly membership node script/launch/add_launch_data.js

Hint: yarn run launch:local [YOUR_PG_USERNAME] is a shortcut for the 3 commands above.

Run it.

yarn run dev

Checkout the API: http://localhost:3020/graphiql

• signin
• me

### Usage with Docker

You can start the whole stack with docker-compose in production mode:

  docker-compose build && docker-compose up
  open http://localhost:8080/graphiql

If you just want to start redis & postgres for local development:

  docker-compose up -d redis postgres
  yarn run dev

backend-modules

To develop backend-modules first run yarn run link inside a local copy of the backend-modules repo then execute yarn run link:backend-modules here. The backend-modules are now symlinked inside node_modules and development should work seamlessly.

Seed: crowdfunding

To quickly get up and running with a working crowdfunding backend, please follow this crazy path to populate the database. We will (maybe) come up with something more convenient in the future.

  dropdb republik
  createdb republik

edit script/db-migrate-all.js and comment out the path "migrations".

  yarn run db:migrate:up
  psql postgres://YOUR_USERNAME@localhost:5432/republik -c "ALTER TABLE companies add column title TEXT"
  psql postgres://YOUR_USERNAME@localhost:5432/republik -c "ALTER TYPE \"paymentType\" ADD VALUE IF NOT EXISTS 'MEMBERSHIP_PERIOD' AFTER 'PLEDGE'"

revert the changes to script/db-migrate-all.js

  yarn run db:migrate:up

now import the seed data from seeds/crowdfunding.sql:

  psql -u YOUR_USERNAME -d republik -f seeds/crowdfunding.sql

...or use the test data instead:

  DATABASE_URL=postgres://YOUR_USERNAME@localhost:5432/republik-test node seeds/seedCrowdfundings.js

Seed: comments

The mocked API is not ideal to test the pagination of the comments root query. Complete the following steps to get exemplary nested comments with working pagination.

• download comments.json from here
• move comments.json to ./seeds/
• run node seeds/seedComments.js
• Test with the following queries:
  • comments
  • more comments

Testing

Boostrap your .test.env file. Only non-existing env variables in that file will get set by .env

DATABASE_URL=postgres://postgres@localhost:5432/republik-test
STRIPE_PLATFORM=COMPANY_ONE
STRIPE_CONNECTED_ACCOUNTS=COMPANY_TWO

STRIPE_ACCOUNT_ID_COMPANY_ONE=
STRIPE_SECRET_KEY_COMPANY_ONE=
STRIPE_ACCOUNT_ID_COMPANY_TWO=
STRIPE_SECRET_KEY_COMPANY_TWO=

Run tests.

yarn run test

Licensing

The source code and it's documentation is licensed under GNU AGPLv3+.