Git Product home page Git Product logo

unacademic-api's Introduction

unacademic-API

This is the repository of the API for the Coding the Humanities unacademic web application.

Up and Running (quick and dirty)

  1. Fork and clone this repository.
  2. Move into the repo directory with cd unacademic-api.
  3. Install dependencies with npm install.
  4. Run grunt to begin a watch and lint task.
  5. Run mocha test/<resource name>(e.g. mocha test/places.js) to run the tests.
  6. Run node index.js to start the server.

Setting up local development environment with vagrant

  1. ensure ansible > 1.8.2, virtualbox and vagrant > 1.7.2 are installed.
  2. npm install.
  3. vagrant up
  4. npm run provision-vagrant
  5. vagrant ssh
  6. inside the vagrant box, run
    • cd /home/deploy/unacademic/
    • pm2 start index.js
    • when necessary, reload the server with pm2 reload all
    • view logs of pm2 with pm2 logs
  7. visit browser 33.33.33.33 and 33.33.33.33/api/0

Setting up staging environment

  1. create a box on digitalocean and change the root password through SSH
  2. configure the ip adress in devops/inventories/staging.yml
  3. npm run provision-staging

Deploying to environment

  1. commit all required changes to repository
  2. npm run deploy-staging

unacademic-api's People

Contributors

marijnkoolen avatar peterpeerdeman avatar

Watchers

James Cloos avatar  avatar

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.