roxanne1225/graphademic

CS411 Course Project

Graphademic

Setup

yarn

Development

Starting both an API and frontend instance

yarn dev

Deployment

This repository uses automatic deploys with Heroku on the master branch.

graphademic's Issues

Implement CRUD Endpoints for "Researchers"

Requires #2

This was the starting point for this:
#1

API Design:
https://docs.google.com/document/d/1TdQEt5VsO6ULfXvALdZlrlJqvr3dkJa8__IKuaxzjNs/edit?usp=sharing

The API should return proper HTTP status codes.
Examples:
200 OK
404 Not Found
204 Ok, no content
500 Internal Server Error

For now, the API only needs to return data fixures. We can connect it to the database once #2 is done.

Setup frontend to render researcher fixtures

Implement CRUD API Endpoints for "Articles"

Requires #2

This was the starting point for this:
#1

API Design:
https://docs.google.com/document/d/1TdQEt5VsO6ULfXvALdZlrlJqvr3dkJa8__IKuaxzjNs/edit?usp=sharing

The API should return proper HTTP status codes.
Examples:
200 OK
404 Not Found
204 Ok, no content
500 Internal Server Error

For now, the API only needs to return data fixures. We can connect it to the database once #2 is done.

Get data into neo4j database

Using the googlescholar dataset, we need to get that information into our neo4j database.

The dataset doesn't include citation relationship information which is why #9 exists.

Setup Jest Testing, Prettier Formatting, ESLint

As title.

Setup connection to GrapheneDB (Neo4j)

Login Credentials should be stored in a .env file
dotenv npm package

Connection script should be under /api/

Setup Graph Visualization

Good package to use: https://www.npmjs.com/package/react-d3-graph

For now, we need to create data fixtures as a stand-in for our API (until it's done). Then we want to render some graphs representing the data in the fixture.

TODO:
[ ] Create data fixture for some graph. We don't know what the api design for this is yet so don't worry about making a fake api client. The data fixture can be used directly in the component.
[ ] Render the data fixture using the react-d3-graph package in the /explore tab

Scape citation data off of google scholar

And get it into our GrapheneDB if possible.

I'd suggest using python or javascript for this issue...

For Python:
https://www.crummy.com/software/BeautifulSoup/bs4/doc/
https://selenium-python.readthedocs.io/getting-started.html

For Javascript:
https://github.com/cheeriojs/cheerio
https://github.com/puppeteer/puppeteer

Setup frontend to render article fixtures