Skip to content
💻 📔 Android app that caters to the need of an undergraduate student
Java
Branch: development
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
.github fix: Added Issue and PR templates Jan 25, 2018
.idea feat: Use Timber for Logging (#36) Oct 14, 2018
ImagesAndScreenshots TEMP: Added screenshots Jun 29, 2017
app
gradle/wrapper Initial Commit Jun 17, 2017
.gitignore fix: Added Issue and PR templates Jan 25, 2018
README.md fix: Added Issue and PR templates Jan 25, 2018
SampleKeyStore.jks TEMP: Added a temporary keystore and signing config to submit the pro… Jun 29, 2017
build.gradle feat: Use Timber for Logging (#36) Oct 14, 2018
gradle.properties Initial Commit Jun 17, 2017
gradlew
gradlew.bat Initial Commit Jun 17, 2017
settings.gradle Initial Commit Jun 17, 2017

README.md

My Companion

Old Name - Student Companion

CircleCI

App Web Image

"My Companion" is an all in one Android application which is meant to cater the needs of an Undergraduate student. It is for the Student community by the Student community.

HomeScreen

HomeScreen

Features

This project will be continuously improved and new features will be added to make it bigger and better. So far the application has the following modules:

  • Coding Calendar

    1. Upcoming competitive coding contests
    2. Details of each contest
    3. Ability to set reminders
    4. Ability to share the contest link and description
  • Flash Cards

    1. Create and organise flash cards according to topics and priority
    2. Store flash cards with questions and answers
    3. Share a flash card
  • PDF Creator

    1. Select a set of images and change it into a PDF document.
    2. Organise and open the pdf from the application itself.

Screens

  • Coding Calendar

    1. Home Screen
      Home Screen

    2. Contest Detail Contest Detail

    3. Two-Pane Tablet Tablet

  • Flash Cards

    1. Home Screen Home Screen

    2. Flash Cards Add Topic Add Topics

    3. Flash Cards Add Card Add Card

    4. Flash Cards Details Card Details

  • PDF Creator

    1. Home Screen Home
    2. Create PDF Create pdf

Branches

The repository contains three branches:

  1. Release: The last stable release version of the application. NOTE: The app is yet to be released on the playstore.

  2. Development: All the development will go here. If you want to open a PR, make sure it is on this branch.

  3. Master: The main branch that has the most stable version of the application.

Contributing

Feel free to fork this project, commit changes and respond through pull requests. Make changes to the "development" and "development2" branches depending on the changes that you want to make and then submit pull request to the above two branches only.

This project is actively maintained by srv-twry. For any queries , feel free to contact at srv.twry@gmail.com

Credits

Project License

Copyright (C) 2017 Saurav Tiwary

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Other open source Licenses

Android source code

Copyright (C) 2011 The Android Open Source Project
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
You can’t perform that action at this time.