CMPS 115 Initial Release

.babelrc

@@ -0,0 +1,13 @@
+{
+  "env": {
+    "development": {
+      "presets": ["next/babel"]
+    },
+    "production": {
+      "presets": ["next/babel"]
+    },
+    "test": {
+      "presets": [["next/babel", {"preset-env": {"modules": "commonjs"}}]]
+    }
+  }
+}

.eslintignore

@@ -0,0 +1,13 @@
+node_modules/
+.next/
+.idea/
+coverage/
+static/
+spider/
+data/
+assets/
+crawlers/
+docs/
+*.json
+*.md
+LICENSE

.eslintrc

@@ -0,0 +1,26 @@
+{
+  "extends": [
+    "eslint:recommended",
+    "plugin:react/recommended",
+    "fbjs"
+  ],
+  "env": {
+    "browser": true,
+    "commonjs": true,
+    "node": true,
+    "es6": true
+  },
+  "parserOptions": {
+    "ecmaVersion": 8,
+    "sourceType": "module"
+  },
+  "parser": "babel-eslint",
+  "rules": {
+    "no-console": "off",
+    "strict": [
+      "error",
+      "global"
+    ],
+    "curly": "warn"
+  }
+}

.gitignore

@@ -1,61 +1,25 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
+# See https://help.github.com/ignore-files/ for more about ignoring files.
 
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
+# dependencies
+/node_modules/
 
-# Dependency directories
-node_modules/
-jspm_packages/
+# testing
+/coverage/
 
-# TypeScript v1 declaration files
-typings/
+# production
+/build/
+/dist/
+/.next/
 
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
+# misc
+.DS_Store
 .env
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+/.idea/
+package-lock.json
 
-# next.js build output
-.next
+*.pyc
+/.coveralls.yml

.travis.yml

@@ -0,0 +1,10 @@
+language: node_js
+node_js:
+  - "8"
+  - "9"
+  - "10"
+install:
+  - npm install
+script:
+  - npm run pretest
+  - npm run test:ci

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Course Graph
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1 +1,126 @@
-# CourseGraph
+<p align="center">
+
+![coursegraph](./assets/logo.png)
+
+[![Build Status](https://travis-ci.org/coursegraph/CourseGraph.svg?branch=development)](https://travis-ci.org/coursegraph/CourseGraph)
+[![Coverage Status](https://coveralls.io/repos/github/coursegraph/CourseGraph/badge.svg)](https://coveralls.io/github/coursegraph/CourseGraph)
+[![tested with jest](https://img.shields.io/badge/tested_with-jest-99424f.svg)](https://github.com/facebook/jest)
+[![jest](https://jestjs.io/img/jest-badge.svg)](https://github.com/facebook/jest)
+[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/coursegraph/CourseGraph/blob/master/LICENSE.md)
+
+</p>
+
+## Introduction
+
+The course search software offered by UCSC (and most colleges) kind of sucks, and there is no easy way to explore classes and majors without a counselor – and the counselors could probably use some help too!
+
+Solution? CourseGraph, a webapp that will:
+
++ datamine pisa and the registrar for course information and sections (and major / minor requirements if we can do that)
++ display this information visually as a web of interdependent courses and major requirements, filterable and presented through different layers and views
+
+Technology: we will need
+
+ + a web frontend (probably React, Typescript, D3) and people interested in UX and software design (myself included)
+ + a web backend (probably node) and people interested in backend development and data storage / retrieval
+ + several web crawlers to datamine UCSC sites and maybe others; anyone interested in this please apply!
++ possible integration of other web services (if we could embed eg. ratemyprofessors that would be awesome)
+
+Is this feasible in <5 weeks?
+
+ + Yes, but it will be challenging as we'll have a lot of work to do
+ + Plus side is we all get to wear lots of hats and use a lot of cool tech to build a real tool that students and counselors can use to explore class options and make planning schedules a lot easier
+ + This project can be subdivided with 2-3 teams working in parallel on different components (eg. frontend and data mining), so we should be able to work without too many bottlenecks
+
+You do NOT need to have experience with typescript, react, node, or d3 to join this project, just a good attitude and a willingness to learn and contribute.
+
+That said, you will need time to learn a bit of typescript and either frontend (react, d3), backend (node, databases – ask Ivan), or data mining (web crawlers, either node or python), since we'll probably be splitting into sub-teams that focus on one of those categories. And you'll need to do this fairly quickly (ie. over the next few weeks) since we'll need to hit the ground running as soon as possible. Oh, and if you'd like to do project management (as one of your many hats) that would be very useful too.
+
+I'll be learning react and d3 over the next week or so, so if you're interested in that (whether you're a part of this team or not) please hit me up! ([email protected])
+
+## Getting Started
+
+These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. (To developers) See deployment for notes on how to deploy the project on a live system.
+
+### Prerequisites
+
+[Node.js](https://nodejs.org/en/) - JavaScript runtime built on Chrome's V8 JavaScript engine.
+
+The minimum supported Node version is `v6.0.0` by default. (We are using `v10.0.0`).
+
+```
+node --version
+
+// v10.0.0
+```
+
+### Installing
+
+Clone our repository (or unzip the project and cd into the root folder),
+
+```
+git clone https://github.com/coursegraph/CourseGraph myProject
+cd myProject
+```
+
+And install dependencies, via [`npm`](https://www.npmjs.com/) (installed with Node.js).
+
+```
+npm install
+```
+
+### Running the project
+
+Running the project is as simple as running
+
+```
+npm run dev
+```
+
+This runs the `dev` script specified in our `package.json`, and will spawn off a server which reloads the page as we save our files. Typically the server runs at `http://localhost:3000`, but should be automatically opened for you.
+
+## Running the tests
+
+Testing is also just a command away:
+
+```
+npm run test
+```
+
+This command runs [`jest`](http://jestjs.io/) and [`enzyme`](http://airbnb.io/enzyme/), an incredibly useful testing utility.
+
+### And coding style tests
+
+We uses `TSLint`, just a command:
+
+```
+npm run pretest
+```
+
+## Built With
+
+* [Next.js](https://nextjs.org/) - A lightweight framework for static and server‑rendered applications.
+* [React](https://reactjs.org) - A JavaScript library for building user interfaces
+* [Node.js](https://nodejs.org/en/) - A JavaScript runtime built on Chrome's V8 JavaScript engine.
+* [MongoDB](https://www.mongodb.com/) - Build innovative modern applications that create a competitive advantage.
+
+## Authors
+
+* **Seiji Emery** ([SeijiEmery](https://github.com/SeijiEmery) ) -
+* **Yanwen Xu** ([RaiderSoap](https://github.com/RaiderSoap) ) - :floppy_disk: Back-End Developer
+* **Patrick Lauderdale** ([ThePatrickLauderdale](https://github.com/ThePatrickLauderdale)) -
+* **Sharad Shrestha** ([sharad97](https://github.com/sharad97) ) -
+* **Wendy Liang** ([wendyrliang](https://github.com/wendyrliang) ) -
+* **Ka Ho Tran** ([Kutaho](https://github.com/Kutaho) ) -
+
+See also the list of [contributors](https://github.com/coursegraph/CourseGraph/settings/collaboration) who participated in this project.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
+
+## Acknowledgments
+
+Big thanks to Richard Jullig.
+
+:kissing_heart:

components/Course.jsx

@@ -0,0 +1,30 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+
+/**
+ * @inheritDoc
+ */
+class Course extends React.Component {
+  static propTypes = {
+    title: PropTypes.string.isRequired,
+  };
+
+  static defaultProps = {
+    title: 'Null',
+  };
+
+  /**
+   * @return {Element}
+   */
+  render() {
+    return (
+      <div className="Course">
+        <h3>
+          {this.props.title}
+        </h3>
+      </div>
+    );
+  }
+}
+
+export default Course;

components/Course.test.jsx

@@ -0,0 +1,17 @@
+import React from 'react';
+import { shallow } from 'enzyme';
+
+import Course from './Course';
+
+
+describe('A Course', () => {
+  it('should render default text without throwing an error', () => {
+    const wrapper = shallow(<Course/>);
+    expect(wrapper.find('h3').text()).toEqual('Null');
+  });
+
+  it('should render title props without throwing an error', () => {
+    const wrapper = shallow(<Course title="CMPS 101"/>);
+    expect(wrapper.find('h3').text()).toEqual('CMPS 101');
+  });
+});

components/Header.jsx

@@ -0,0 +1,34 @@
+import React from 'react';
+import NextHead from 'next/head';
+import NProgress from 'nprogress';
+import Router from 'next/router';
+
+Router.onRouteChangeStart = (url) => {
+  NProgress.start();
+};
+
+Router.onRouteChangeComplete = () => NProgress.done();
+Router.onRouteChangeError = () => NProgress.done();
+
+/**
+ * A header Component that provide Progress bar
+ * @return {*}
+ */
+export default () => (
+  <div style={{marginBottom: 20}}>
+    <NextHead>
+      <meta charSet="UTF-8"/>
+      <title>Course Graph</title>
+      <meta
+        name="description"
+        content="A lightning-fast search for your UCSC courses"
+      />
+      <meta name="viewport" content="width=device-width, initial-scale=1"/>
+      <link rel="icon" sizes="192x192" href="/static/touch-icon.png"/>
+      <link rel="apple-touch-icon" href="/static/touch-icon.png"/>
+      <link rel="mask-icon" href="/static/favicon-mask.svg" color="#49B882"/>
+      <link rel="icon" href="/static/favicon.ico"/>
+      <link rel="stylesheet" type="text/css" href="/static/nprogress.css"/>
+    </NextHead>
+  </div>
+);

components/Instantsearch.jsx

@@ -0,0 +1,5 @@
+import { createInstantSearch } from 'react-instantsearch/server';
+
+const {InstantSearch, findResultsState} = createInstantSearch();
+
+export { InstantSearch, findResultsState };