README.md

· Report a bug · Request a feature ·

Table of Contents

1. About The Project
   • Features
   • Tech Stack
   • Screenshots
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Reach out
7. Acknowledgements

About the project

FFCSeZ is an app to facilitate the smooth and hassle-free preparation of timetables during FFCS and keeping a track of daily classes and related to-dos, with a host a of new and student-centric features. The app can be used by any student studying in VIT right from the first years to the final years.

Features

• Updated with the latest faculty information for FFCS.
• Minimalistic and smooth UI for creating timetables on mobile.
• Easy add/drop courses with credit management.
• Filters to help you narrow down to your preferred slots.
• Support for multiple mock time tables.

Tech Stack

Screenshots

Home Screen

Course Selection Screen

Registered Courses

Legacy Timetable View (Full Screen - Landscape)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

In order to get a copy of the project you will require you to have Android Studio (v4.0 and above) installed. If you don't have it, you can download Android Studio from the official website.

Installation

Open Android Studio, select Import from Version Control and paste the following link to clone the repository:

https://github.com/Team-Fourth-Dimension/FFCSeZ.git 

Run a Gradle build if there is some error in syncing the dependencies. Generate an APK by going to Build > Build APK and install it on your Android device or run the app from within Android Studio either by using an emulator or by USB debugging.

Note that you will have to add your own google-services.json file under ../app for the Gradle build to succeed.

Roadmap

The main features of the app are broken down into a technical task timeline.

• Task 1: Project Setup

  • Add the required dependencies for library support.
  • Setup database services.

• Task2: Setting up the FFCS interface and database

  • Build the UI for the FFCS selection screen.
  • Adding query methods from the database for the selection.
  • Add chips and set up a filter system.
  • Build the UI for the slot display screen.
  • Build UI for Full TimeTable Screen.

• Task 3: Setting the Timetables

  • Build the UI for the timetable display.
  • Setup app navigation.
  • Code for the database storage of timetables.
  • Wrap up the code of Task 2 and the code of Task 3.
  • Complete debug till Task 3.

• Task 4: The Navigation Pane

  • Setup the functionality to add and display the existing timetables of the user.
  • Adding the import timetable feature.
  • Add notifications to remind when new FFCS data has arrived
  • UI cleanup.
  • Add an app tutorial.

• Task 5: Cleanup

  • Cleanup or improvise the UI/UX.
  • Refactor code and code optimizations.
  • Implement a dark theme and its toggle.

• Task 6: Additional features

  • Setup faculty reviews database and UI.
  • Add more student-centric features.

• Task 7: Widgets and Additional features

  • Build a widget of the current timetable.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project. (Refer the get started instructions)
2. Create your Feature Branch. (git checkout -b feature/AmazingFeature)
3. Commit your Changes. (git commit -m 'Add some AmazingFeature')
4. Push to the Branch. (git push origin feature/AmazingFeature)
5. Open a Pull Request.

License

Distributed under the MIT License. See LICENSE for more information.

Reach out

Arjun Sivaraman via Email · Github · Linkedin

Prasoon Soni via Email · Github · Linkedin

Acknowledgements

1. Freepik - For the background images.
2. Lottie Files - For some of the animated gifs in the app.

With ❤️ by Team Fourth Dimension, IET-VIT