Skip to content

Latest commit

 

History

History
57 lines (40 loc) · 2.83 KB

readme.md

File metadata and controls

57 lines (40 loc) · 2.83 KB
Raw

Memwars

Memory Training Application based on Kotlin for Android

Table of Contents

Introduction

General

Memwars has been an app that I've been planning for a couple of years. I love Memory Challenges and read a lot of content online on improving memory and concentration. This is an app that I hope, will provide the casual and competitive memory challenges that I see getting introduced as a fundamental memory training. The app itself is going to be a base list of games that you can play, I plan on building 8 games (technically 4 with each having easy/hard options). It's also going to have some stats that you can see and measure how good you're doing. Again, some basic timer stuff.

The App seems very basic. Why build it?

The great thing about this app is that it does not bring anything new to the table. So I do not have to worry about great ideas. Sure they might pop up but it's not going to alter the simple core functionality of this app. For this application, I am using Waterfall model as the SDLC for this project and focusing on Design Patterns, Clean Code and Good Architecture as much as I can. Because I mean instead of having a great deal of cool arbitrary functions somehow taped together tg. The main focus of this project is better design patterns, clean code,

Although, I'd like for it to be a great and usable app with fun and challenging games that is also going to improve memory. It is more about improving my personal development process. So, for this app, rather than making a great app through poor process and code jumbled together from here and there to make things just work, I'm focusing on making a good app through proper process.

Other priorities include:

  • Maintain Clean Code
  • Incorporate Necessary Design Patterns
  • Keeping Documentation
  • Meeting Time Goals for the App
  • Proper Version-ing based on features added
  • Use JWT for Auth (Low priority for now)

Features

  • 0.1.0 - Home, Reusable Games List Added (Info for Word War), Initial DB Schema Created (✔)️DB Schema
  • 0.1.1 - Add Other Games Info, Update Game Selector Navigator (Conditional Routing) (✔)
  • 0.1.2 - Integrate Firebase, Setup Auth, Font & Color Schema, Finish LandingPage with buttons (✔)
  • 0.1.3 - Finish and Implement Login, SignUp pages, functions, utility & Establish User (Singleton Pattern) (✔)
  • 0.1.4 - Home Redesign & Implement (✔)
  • 0.1.5 - Settings Logic Creation and Implementation

Usage

  1. Clone the project using git clone https://github.com/Arceen/Memwars.git
  2. Use Android studio to open the project
  3. Update & Sync gradle
  4. Run the App

Plans

  • Firebase Integration. For authorizations, pfp saving on cloud_firestore, and generating the games list from the server