Skip to content

drayside/se-capstone-db

This branch is 138 commits ahead of wrahman0/se-capstone-db:master.

Folders and files

NameName
Last commit message
Last commit date
Mar 23, 2017
Apr 11, 2019
Nov 28, 2016
Oct 8, 2016
Oct 8, 2016
Mar 3, 2018
Oct 8, 2016
Oct 8, 2016
Oct 8, 2016
Mar 23, 2017
Mar 23, 2017
Mar 23, 2017
Mar 27, 2019
Mar 23, 2017

Repository files navigation

Deployment

Requirements:

Installation

  1. Checkout https://github.com/drayside/se-capstone-db.git
  2. From the root folder, run npm install
  3. After installation, run nodemon server.js [ --markdown-directory <path> ]
  4. Point your browser to localhost:3000

API Documentation

1. Users

1.1 List all projects: [GET] /project/all

Description

Returns a list of all projects. Includes: Name, Project ID, Year, Abstract.

  • Endpoint: /project/all/

Request:

  • Header: {}
  • Body: {}

Response:

{
    projects: [
        {
            "name": [STRING],
            "year": [STRING],
            "abstract": [STRING],
            "pid": [INT],
            "program": [STRING]
        },
    ]
}

Response Status Codes:

  • Success Code: {200: 'Success'}
  • Error Code: {404: 'NotFoundError'}

1.2 Get single project information: [GET] /project/:id

Description

Get project details for the specified project id.

  • Endpoint: /project/:id
    • : identification for the target user.

Request:

  • Header: {}
  • Body: {}

Response:

{
    "id": [INTEGER],
    "name": [STRING],
    "students": [STRING],
    "year" : [INTEGER],
    "status" : [STRING],
    "tags" : [STRING],
    "abstract" : [STRING],
    "external_partners" : [STRING],
    "program": [STRING]
}

Response Status Codes:

  • Success Code: {200: 'Success'}
  • Error Code: {404: 'NotFoundError'}

2.1 Search based on filters: [POST] /search

Description

Searches for projects based on different filters. For now, the API supports searching by name, status, tags and year.

  • Endpoint: /search

Request:

  • Header: {}
  • Body:
{
    "name": [STRING],
    "status": [STRING],
    "tags": [STRING],
    "year": [STRING]
}

Response:

{
    projects: [
        {
            "name": [STRING],
            "year": [STRING],
            "abstract": [STRING],
            "pid": [INT],
            "program": [STRING]
        },
    ]
}

Response Status Codes:

  • Success Code: {201: 'SearchCompleted'}
  • Error Code: {400: 'BadRequest'}

About

API interface for the front-end

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 41.7%
  • Alloy 39.2%
  • Python 8.0%
  • HTML 4.9%
  • Shell 4.7%
  • CSS 1.5%