Drift

A cool Markdown slideshow creator and remote app. This is only like, 50% complete.

Getting Started

Make sure you have the following dependencies installed globally:

Clone the repo using git clone or by clicking the Download ZIP button to the right.

git clone https://github.com/jadnco/drift.git

Navigate to the cloned directory

cd Drift

Install all dependencies using npm:

npm install

Run the default Gulp task to get started:

gulp

Next, make sure to start an instance of MongoDB:

sudo mongod

Once the database is up and running, you can start the app"

node app.js

For development, I am using nodemon to listen for any changes in the scripts. Otherwise, the server would need to be restarted manually for every change.

If you are working within a GitHub repo you can deploy your project, at any time, to a gh-pages branch by running:

gulp deploy

Credits

Responsive grid from Skeleton by Dave Gamache

API

Slideshow

GET

Returns a list of all slideshows

Example

GET /api/slideshows

Response:

{
  "slideshows": [
    {
      "_id": "561ff1aadf537cd4f9501f9f",
      "token": "9846",
      "modified": "2015-10-15T19:53:48.889Z",
      "created": "2015-10-15T18:34:18.605Z",
      "slides": [
        {
          "location": 0,
          "content": "<h1>This is the first slide.</h1>",
          "_id": "561ff1aadf537cd4f9501fa0"
        }
      ],
      "position": 2
    },

    ...
  ]
}

GET

Returns a single slideshow by token or _id.

Example

GET /api/slideshow/:token:id

Response:

{
  "slideshow":[
    {
      "_id":"561ff1aadf537cd4f9501f9f",
      "token":"9846",
      "created":"2015-10-15T18:34:18.605Z",
      "slides":[
        {
          "location":0,
          "content":"<h1>This is the first slide.</h1>",
          "_id":"561ff1aadf537cd4f9501fa0"
        }
      ],
      "position":0
    }
  ]
}

PUT

Update a single slideshow by token or _id.

Example

PUT /api/slideshow/:token:id

Request:

{
  "slideshow":{
    "position": 2
  }
}

Response:

200 OK

POST

Create a new slideshow record

Example

POST /api/slideshows

Request:

{
  "slideshow": {
    "position": "1903"
  }
}

Response:

{
  "slideshow": {
    "_id": "562004e1f73eb2e915abeab5",
    "created": "2015-10-15T19:56:16.999Z",
    "slides": [],
    "position": 1903
  }
}