Giter VIP home page Giter VIP logo

nulinks's Introduction

NULinks Build Status

MyNortheastern but faster and easier!

NULinks is a chrome extension and website to enable Northeastern students to quickly access Northeastern University websites. The website also serves as a Progressive Web App, so it can be easily installed onto the home screen of Android and iOS devices.

NULinks is unofficial and run by students.

NULinks Browser Extension NULinks Website

Usage

Users activate the extension by typing "nu" and then space or tab into the browser's address bar. Once activated, they can quickly search for any of the Northeastern sites, such as Blackboard, Husky Mail, NUCareers, NU Dining, XFINITY On-Campus, Student Employment, PaperCut and many more. The extension specific logic lives in the nulinks-extension folder.

Clicking on the extension's icon or activating the extension and then immediately pressing enter without searching for anything will bring users to the extension's detailed search page where they can scroll through the results and see longer descriptions. This webpage is build from the React app that lives in nulinks-site. This app is also deployed to the public url: https://nulinks.kj800x.com

The searching logic (which determines which results show in what order for which search terms), and the raw data for the links lives in the nulinks-common folder and is automatically pulled into the builds for the site and extension.

Automation

Test (Continuous Integration)

Any commit that is pushed to the repo has these checks run on it:

  • The jest tests for nulinks-common pass.
  • The React build for nulinks-site succeeds.
  • Required files pass Prettier.

Deploy (Continuous Delivery)

Any commit to master will automatically trigger the following deploys:

  • nulinks-site is built and deployed to the nulinks.kj800x.com S3 bucket.
  • nulinks-extension is built and deployed to the Chrome Web Store.

Contributing

Contributions of any kind are welcome. For major changes, please open an issue first to discuss what you would like to change.

We rely on users to know what links you actually want and are actually useful to you, so please open an issue if you have any ideas or suggestions for the links.

For more details, please read our Contributing Guidelines.

License

NULinks is MIT Licensed.

nulinks's People

Contributors

dependabot[bot] avatar kj800x avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

muskanmahajan37

nulinks's Issues

Tuning: sched

sched -> My Schedule (it's actually linking to Schedule of Classes)

eRezLife

(also have it match ezrezlife because I can't handle 'e' as a prefix and automatically add the z by accident)

northeastern.erezlife.com

Simplify Dashes

Dashes should be ignored when matching and presentational only.

Copy Review all text

Initially, all text was sourced from MyNEU. The text has varying verbosities, and we should be able to standardize them

Food trucks table spills on mobile

Screenshot_20191114-145158
Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:
e.g.

  1. Go to '...'
  2. Click on '....'
  3. Scroll down to '....'

Actual behavior
A clear and concise description of what actually happened.

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

  • OS and version: [e.g. Window 10 version 1803]
  • Browser and version: [e.g. Chrome 71.0.3578.98, Safari 12.0.2]

Smartphone (please complete the following information):

  • Device: [e.g. iPhone6]
  • OS: [e.g. iOS8.1]
  • Browser [e.g. stock browser, safari]
  • Version [e.g. 22]

Additional context
Add any other context about the problem here.

New Link Suggestion: microsoft-office

Prioritize the beginnings of words

We should do something to prioritize beginnings of words over middles of words:

Example:
Searching y:
First result is nusso because library is in the description (which has a y) and has frequency of "a few times a semester"
y probably should go to yearbook

Travis rebuilding the code 3 times

Ideally, we don't have travis build the app again when it goes to do the deployment stages, but as of now, there isn't a good way to reuse the artifacts from earlier stages in later stages in travis. If we can use the code from the compile-site stage in the deploy to s3 and the upload to webstore stages, we could cut down on build times a ton!

Get this ready for public release

Things to think about

  • What channels do we want to announce it via (Facebook? The Meme Collective? The Northeastern Page? The Northeastern CCIS Page? The "Not A Meme But" Page?
  • Maybe reach out to SearchNEU to see their thoughts?
  • Fliers (that's what SearchNEU did)?

Todo

  • Make sure that the GitHub is all ready (per the Insights/Community tab)
    • Contributing guidelines
    • Readme #25
  • Prepare developer experience
    • Ensure that the build server is back up so that we can do rapid turnaround
    • Solve the Babel / Webpack issue #51
    • Add additional tests

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.