Giter Club home page Giter Club logo

loginion's Introduction

Loginion Build Status Code Climate Test Coverage Issue Count

A replacement for the ION Login page on the campus of MIT, Manipal.

If there are issues, please report them in the issues page

Installing

Head over to the Downloads section and download the package for your platform (Window, Mac OS, or Linux)

Mission / Why?

We all know ION is kinda sucky. We love you guys for giving us Internet, but there are a lot of ways this could be improved.

This is an effort by some students in Manipal to try and open channels of communication between us and ION by doing the thing we do best - writing code.

We would like to show that the students (and faculty) of MIT support good UI, thoughtful design, and above all, deserve a better Internet experience that the one available right now.

This application can help relieve some of the burden on the usability side of things, but we have no control of the servers. However, by initiating this project, we would love to start a dialog that will hopefully allow us to improve the Internet infrastructure as a whole in MIT.

TL;DR - we like Internet. We like pretty things. Let's make our Internet access pretty.

Contributing/Development

Install nwjs

Grab nwjs (which is the platform we run on), from the official website.

fork and clone our repository

To get started, fork the repository and clone from it

git clone https://github.com/<your-username>/loginion.git

cd into the folder

cd /path/to/repo/loginion

Install all dependencies with npm

This pulls in all the dependencies that are used, such as the testing frameworks and different libraries

npm install

create a branch with an appropriate name. eg. feature-colored-buttons or fix-bug-stack-overflow

git branch my-branch-name

push to the branch, and make sure your changes work

git add ...
git commit ...
git push ...

test with npm test, and fix all the JS and CSS linting errors.

npm test

create a pull request against our repository

fix bugs highlighted by Travis until you get a bright green tick

pester us until we merge it

Thanks a lot!

Getting Started with Contribution

Someone please write this down

send a Pull request our way, we'll be glad to accept.

To Do

  • Build a GUI frontend
  • Setup a travis build system
  • Setup a unit testing suite (will have to look for one)
  • use nwjs-builder to create a proper binaries
  • create a for-contributors.md for, well, contributors

Contacts

Anyone who wishes to contact people personally on-campus can approach us:

(Anyone who is interested to be on this list can send us a Pull Request)

License

The MIT License (MIT) Copyright (c) 2016-2017 Hawklings

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 URPOSE 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.

loginion's People

Contributors

bollu avatar znavfu avatar

Watchers

 avatar

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.