https://github.com/zoetrope69/units4u
:+1::performing_arts::-1: a university unit recommender system based on natural language (sentiment)
https://github.com/zoetrope69/units4u
natural-language recommender-system sentiment uni
Last synced: 8 months ago
JSON representation
:+1::performing_arts::-1: a university unit recommender system based on natural language (sentiment)
- Host: GitHub
- URL: https://github.com/zoetrope69/units4u
- Owner: zoetrope69
- Created: 2016-01-23T15:49:47.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-02-02T23:56:22.000Z (over 9 years ago)
- Last Synced: 2025-04-03T12:15:49.250Z (about 1 year ago)
- Topics: natural-language, recommender-system, sentiment, uni
- Language: JavaScript
- Homepage: http://units4u.herokuapp.com
- Size: 2.95 MB
- Stars: 1
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# units4u
:+1::performing_arts::-1: a university unit recommender system based on natural language (sentiment)
_for the second sprint of our web research unit, you can [read our paper](https://docs.google.com/document/d/1oy942wvf2_ky_KW5UOGM7cLmYUq7qCcSS8G49cOBxKk) or go [look at the demo site](https://units4u.herokuapp.com/) (note it's on heroku so may take some time to boot)_
[](https://travis-ci.org/zaccolley/units4u)
# install
most of this project will be using node so you'll need to install any dependencies. we're using eslint to lint the project.
make sure you're using a **node version 4 or above** for es6 (es2015) features
1. `npm install -g eslint`
2. `npm install`
3. Install and start neo4j
4. copy the `.env-sample file` to `.env` and add details (username and password for neo4j, [indeed api publisher api key](http://www.indeed.co.uk/publisher)).
7. [Optional] `node app/test` - Test it's working
## neo4j
you'll need to [download and install neo4j (community edition)](http://neo4j.com/download/).
to drop the database you can use the cipher command: `MATCH (n) DETACH DELETE n`
# run
1. `neo4j start` - start neo4j
2. `npm start` - will seed db automatically if not seeded
# code styleguide
we're using [EditorConfig](http://editorconfig.org) to set-up our coding style, you can [install a plugin for this to take effect](http://editorconfig.org/#download)
_e.g for atom `apm install editorconfig`_
our linter will also pick up things like this as well
# linting
linting is done with eslint, you can install it your ide. running `npm run lint` will run the linter command line.
# deployment
make sure you build the latest clientside script to ES5 using `npm run build`, add it to the repo for now and push up
# /experiments
section for experiment with our different tech and algorithms
# /resources
currently we're using this folder to dump data that'll we'll process in the future
# credit
using the wonderful [twemoji emoji set](https://github.com/twitter/twemoji)