- Node v4.1.0
- Node Package Manager (npm)
- GraphViz CLI
- Checkout https://github.com/drayside/se-capstone-db.git
- From the root folder, run
npm install
- After installation, run
nodemon server.js [ --markdown-directory <path> ]
- Point your browser to
localhost:3000
Returns a list of all projects. Includes: Name, Project ID, Year, Abstract.
- Endpoint:
/project/all/
- Header:
{}
- Body:
{}
{
projects: [
{
"name": [STRING],
"year": [STRING],
"abstract": [STRING],
"pid": [INT],
"program": [STRING]
},
]
}
- Success Code:
{200: 'Success'}
- Error Code:
{404: 'NotFoundError'}
Get project details for the specified project id.
- Endpoint:
/project/:id
- : identification for the target user.
- Header:
{}
- Body:
{}
{
"id": [INTEGER],
"name": [STRING],
"students": [STRING],
"year" : [INTEGER],
"status" : [STRING],
"tags" : [STRING],
"abstract" : [STRING],
"external_partners" : [STRING],
"program": [STRING]
}
- Success Code:
{200: 'Success'}
- Error Code:
{404: 'NotFoundError'}
Searches for projects based on different filters. For now, the API supports searching by name, status, tags and year.
- Endpoint:
/search
- Header:
{}
- Body:
{
"name": [STRING],
"status": [STRING],
"tags": [STRING],
"year": [STRING]
}
{
projects: [
{
"name": [STRING],
"year": [STRING],
"abstract": [STRING],
"pid": [INT],
"program": [STRING]
},
]
}
- Success Code:
{201: 'SearchCompleted'}
- Error Code:
{400: 'BadRequest'}