README.md

My Companion

Old Name - Student Companion

"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

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
     

  2. Contest Detail

  3. Two-Pane Tablet

• Flash Cards

  1. Home Screen

  2. Flash Cards Add Topic

  3. Flash Cards Add Card

  4. Flash Cards Details

• PDF Creator

  1. Home Screen
  2. 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 [email protected]

Credits

• Volleyused to transmit data in a background thread.
• Butterknife used to bind the views.
• RippleEffect used for the Material ripple effect.
• ImagePicker used for picking images to create PDFs.
• iText used to convert images to PDF files.
• material-dialogs used for the Material dialogs.
• Pixabay for the open source images and icons.

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.