Skip to content

ssn-developers/ssn-app

Repository files navigation

Cover Image

SSNCE

Join our active, engaged community:
Playstore | Discord | Facebook | Instagram

License PRs Welcome Issues Enhancement Welcome

SSNCE App allows you to get timely updates on feeds, events, workshops, clubs and placements from respective departments and exam cell.

Installation Setup

Fork Project

  • Fork the Main Repository.

  • Clone the forked repository git clone forked_repo_url

  • Import the cloned project into Android Studio.

Setup Firebase

  • Create a firebase project and add your android app to that project.

  • Enable Google Sign-In in the Firebase console:

    • On the Authentication section, choose the Sign-in method tab and enable the Google sign-in method.
  • Add your app's SHA-1 fingerprint:

    • Generate SHA-1 key in android studio.
    • Go to Settings page of the Firebase console and add your SHA-1 key under SHA certificate fingerprints.
  • Enable Cloud Firestore database (in test mode) and Storage in your firebase project.

  • Populate mock data by the running the python script in colab.

  • Run the android project in an emulator or a physical device.

Note

  • You may receive an error in the Logcat stating Composite Index not found. Please follow the instruction to create composite index manually.
  • To enable notification in global chat, generate a new API Key from the API console and replace the generated key with the SERVER_KEY variable in Constants file.

Enhancement

Cover Image

Project corner

Project corner is one of the highly recommended features by the ssnites for showcasing their skills and talents. It should help the students and alumni of SSN to share their project works, awards, etc to their peers.

Bus tracking

Tired of calling your bus mates in verifying whether the bus has arrived? Develop the bus tracking feature, to save the trouble of day scholars in tracking the location of the buses in realtime using Google Maps.

Attendance management

Worried about the attendance percentage at the end of every semester, then this feature is for you. Help your bunkmates to track and manage their attendance with ease.

Contribution Guidelines

Git commit messages

To speed up the review process and to keep the logs tidy, we recommend the following simple rules on how to write good commit messages:

Summary line
  • It should contain less than 50 characters. It is best to make it short.
  • Introduce what has changed, using imperatives: fix, add, modify, etc.
Description
  • Add extra explanation if you feel it will help others to understand the summary content.
  • Avoid writing in one line. Use line breaks so the reader does not have to scroll horizontally.

For more information and tips on how to write good commit messages, see the GitHub guide.

Requesting a Feature

You can raise a Github issues to request new features you would like to see in SSNCE app.

  • Provide a clear and detailed explanation of the feature you want and why it's important to add.
  • Keep in mind that we want features that will be useful to the majority of our users and not just a small subset.

Contact us

Discord

Join us in Discord community.

Email

Send an email to ssnmobileapp@ssn.edu.in for more queries.

Contributors

                         

License

MIT License

Copyright (c) 2019 ssn-developers

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.