Giter Club home page Giter Club logo

objective-api's Introduction

Objective API

CircleCI

Installation

Dependencies

  1. Node 6.9 LTS -- n recommended
  2. Yarn
  3. Postgres -- Postgres.app recommended

Set Up

  1. $ yarn
  2. Set up Postgres
    • $ createdb qdb
    • $ psql qdb
    • > CREATE ROLE root WITH LOGIN PASSWORD 'playbooks';
    • Exit
  3. Provision and seed database
    • yarn run db:migrate
    • yarn run db:seed
  4. Create a .env file and get keys
  5. Start application

Yarn Commands

These are all found in package.json scripts. Run them with yarn run <script name>

start

Builds and start the production app.

  • codebase has async/await and some future-ES features and need to transpile to the Node LTS target
  • uses forever to run the app
  • uses NODE_ENV, DEBUG, WEB_CONCURRENCY, and PORT from the environment

dev

Starts the development app, which is transpiled on the fly with babel-node

  • Uses Nodemon for live reloading app
  • uses NODE_ENV, DEBUG, WEB_CONCURRENCY, and PORT from package.json

clean

Cleans the prod folder

build

Cleans and runs build:transpile

build:transpile

Build step for transpiled app

db:destroy

Runs sql to reset the db by deleting the schema and recreating it

db:migrate

Runs all knex migrations

db:create:migration and db:create:seed

Wraps knex to create migration and seed files according to the knexfile.js. Migration creation gives it a timestamp to organize migrations sequentially.

db:recreate

Runs db:destroy and db:migrate

db:seed

Runs the seed task

lint

Runs eslint on the app folder

lint:fix

Theoretically fixes small linting issues according to eslint

test

In theory this will allow us to run tests one day... in theory. sigh

ToDo

  • Heroku setup
  • Heroku deploy instructions
  • New customer creation
  • Write up stuff for codemods (jscodeshift -t codemods/transforms/requires-to-imports.js app/**/*.js)

objective-api's People

Watchers

 avatar  avatar

objective-api's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.