README.md

Buvie

What is Buvie?

Buvie is a platform where users can find other people with similar taste in movies and plan to catch a movie with them!

Prerequisites

Buvie requires Node.js v6.0+ to run.

Installing

Buvie requires Node.js v6.0+ to run. Install the dependencies and devDependencies and start the server.

npm install

Running the tests

To run front-end or back-end tests, simply run npm test in the terminal.

Schema

User

{
  username: {
    type: String,
    required: true,
    unique: true
  },
  password: {
    type: String,
    required: true
  },
  email: {
    type: String,
    required: true,
    unique: true
  },
  googleId: {
    type: String,
    default: ''
  },
  genres: [
    {
      type: String
    }
  ],
  movies: [
    ref: Movie
    movieId
  ],
  location: {
    city: String,
    coordinates: [lat, lng]
  },
  geometry: {
    type: "Point",
    coordinates: {
      type: [Number],
      index: '2dsphere'
    }
  },
  popcorned: [{
    type: userId, 
    ref: User 
  }],
  matched: [
    {
      _id: {
        type: userId, 
        ref: User 
      },
      chatroom: {
        type: conversationId, 
        ref: Conversation 
      }
    }
  ],
  ignored: [{ 
    type: userId, 
    ref: User 
  }],
  whoUserPopcorned: [{ 
    type: userId, 
    ref: User 
  }],
  profilePicture: String,
  notifications: [
    {
      _id: { 
        type: userId, 
        ref: User 
      },
      notificationType: String,
      date: { 
        type: Date, 
        default: Date.now 
      }
    }
  ],
  notificationCheck: {
    type: Date,
    default: Date.now
  }
}

Movie

{
  title: String,
  genre: String,
  poster: String,
  users: [{ 
    type: userId, 
    ref: User 
  }],
  imdbID: String
}

Conversation

{
  matched: [{ 
    type: userId, 
    ref: User 
  }],
  messages: [{
    message: String,
    handle: String,
    room: { 
      type: conversationId, 
      ref: Conversation
    }
  }]
}

Geoschema

{
  type: {
    type: String,
    default: 'Point'
  },
  coordinates: {
    type: [Number],
    index: '2dsphere'
  }
}

API Overview

/api
.
├── /auth
│   └── GET
│       ├── /google
│       ├── /google/redirect
│   └── POST
│       ├── /login
│       └── /refresh
├── /users
│   └── GET
│   └── GET /:id
│   └── POST
│       └── /
├── /main
│   └── GET
│       ├── /location
│       ├── /matches/:id
│       ├── /notifications/:id
│       ├── /popcorn/:id
│       └── /profilePicture/:id
│   └── PUT
│       ├── /ignore/:id
│       ├── /ignore/nevermind/:id
│       ├── /location/:id
│       ├── /notifications/time/:id
│       └── /popcorn
│   └── PUT /:id
│   └── POST
│       └── /profilePicture/:id

POST /api/auth/login

// req.body
{
  username: String,
  password: String
}

// res.body
{
  authToken: String
}

POST /api/auth/refresh

// req.header
Authorization: Bearer ${token}

// res.body
{
  authToken: ${token}
}

GET /api/users/

// req.query
{
  ?
}

// res.body
[
  {
    username: String,
    movies: [],
    genres: String
  }
]

GET /api/users/:id

// req.params
{
  id: ID
}

// res.body
{
  username: String,
  movies: [],
  genres: String
}

POST /api/users/

// req.body
{
  email: String,
  username: String,
  password: String
}

// res.body
{
  name: String,
  username: String
}

PUT /api/main/:id

// req.body
{
  genres: [String],
  movies: [{type: MovieId, ref: Movies}]
}

// res.body
{
  [
    username: String,
  _id: UserId,
  genres: [String],
  movies: [{type: MovieId, ref: Movies}]            
}

GET /api/main/

// res.body
{
  [
    username: String,
    _id: UserId,
    genres: [String],
    movies: [{type: MovieId, ref: Movies}]
  ]
}

PUT /api/main/ignore/:id

// req.body
{
  userId: userId
}

// res.body
{
  status: 204
}

PUT /api/main/ignore/nevermind/:id

// req.params
{
  id: userId
}

// res.body
{
  status: 204
}

PUT /api/main/popcorn

// req.body
{
  userId: userId
}

// res.body
{
  status: 204
}

GET /api/main/popcorn/:id

// req.params
{
  userId: userId
}

// res.body
{
  popcorned: [{User: Object}],
  pendingPopcorn: [{User: Object}]
}

GET /api/main/location/?lat:{NUMBER}&lng:{NUMBER}

// req.query
{
  lat: Number,
  lng: Number
}

// res.body
[
  {User: Object}  
]

PUT /api/main/location/:id

// req.body
{
  city: String,
  coordinates: {
    latitude: Number,
    longitude: Number
  },
}

// res.body
{
  User: Object;
}

GET /api/main/matches/:id

// res.body
{
  [
    _id: UserId
    username: String
    chatroom: ConversationId    
  ]
}

GET /api/main/notifications/:id

// req.params
{
  id: ID
}

// res.body
[
  {
    _id: Number,
    message: String,
    date: Number,
    type: String                      
  }
]

PUT /api/main/notifications/time/:id

// req.params
{
  id: ID
}

// res.body
[
  User: Object;
]

GET /api/main/profilePicture/:id

// res.body
{
    _id: UserId
    profilePicture: String
}

POST /api/main/profilePicture/:id

// req.body
{
    _id: UserId
    profilePicture: String
}

// res.body
{
    _id: UserId,
    username: String,    
    profilePicture: String
}

Built With

• Node - Run-time environment
• Express - Web application framework
• MongoDB - Database
• Mongoose - Data modeling
• Passport - Authentication
• JWT - Authentication
• OAuth 2.0 - Authentication
• Mocha - Testing
• Chai - Testing
• Google Geolocation API - Location API

Authors

• Nikolas Melgarejo - Full-Stack - NikolasMSomething

• Cameron Hatch - Full-Stack - CameronHatch92

• Kent Tokunaga - Full-Stack - kenttoku

• Joe Pena - Full-Stack - Joe-Pena

See also the list of contributors who participated in this project.

Acknowledgments

• Jesse Heaslip, Tauhida Parveen, Joe Turner, Chris Klanac, Rich Greenhill, Capi Etheriel, Brandon Hinshaw