sm-heard/fanficio

Description

I decided to create this app because I've found reading fanfiction on fanfiction.net can be annoying sometimes. I've often wished I had features like knowing which chapters I've already read. I wanted to create a minimalist interface for reading that had all the features I wanted.

Currently the app pulls stories (favorite list) off of fanfiction.net(user: Samghost) for offline viewing. Has a clean, simple interface to read stories (material design guidelines color palette). Custom app icon.

Future intended functionality: Uses Google for authorizing (currently nonfunctional), marks chapters already read as READ, marks story as READ when all chapters have been read, database full functional and stories persist without internet connection (currently internet connection is necessary). Rework to MVVM with Reactive framework. Aesthetic customization. Add menu in each chapter to other chapters. Add support for Ao3. Make API more modular with granular Jsoup calls. Test injection with Jsoup. Night mode reading. Color pallete.

Intended Users

Readers of fanfic who want useful features like offline reading and tracking chapters and stories already read.

Requirements

• Android SDK build minimum 21. Tested on SDK 27,28. Hardware: Pixel2(Emulator) and Samsung SM-T290.
• Jsoup, GoogleSignIn
• Internet Connection

Build Instructions

1. Clone the repo [email protected]:sm-heard/fanficio.git
2. Import into Intellij
3. Build with gradle
4. Run with "app" config

Resources

User stories
Wireframes
ERDs
DDL
License
User Instructions
JavaDocs

Demo

First milestones

• Description
• Intended Users
• ERDs
• Wireframes
• User Stories

Second milestones

• Description
• Intended Users
• ERDs
• Wireframes
• User Stories
• Entity Classes
• DAO Interfaces
• Database Class
• DDL
• Chrome Inspectablity

Third Milestone

• Documentation
• Implementation Components