Skip to content

Latest commit

 

History

History
167 lines (118 loc) · 4.65 KB

README.md

File metadata and controls

167 lines (118 loc) · 4.65 KB
Raw

Algo Guide

About

The Algo Guide is an educative android app for studying data structures and algorithms. The app includes algorithm concepts and uses simple visual elements like charts, and other visual elements to simplify the understanding of the working of each algorithm like searching, sorting, etc. The app will also be included with code simultaneously to understand the concepts.

General Info

  • Different algorithm concepts
  • Visualise the best way to make it understandable
  • Embedded code to each algorithm concepts
  • Making user interface using Jetpack Compose
  • Implementing ViewModel concepts

Project Status

🚧🚧 Project is: In progress. check out the progress

Tech stack

Mobile OS Android
Architecture Clean Architecture
Programming Language Kotlin
Database Room
API DSA API
UI Framework Jetpack compose
Push Notification Firebase

Feature List

  • Offline access to lesson
  • Track lessen progress
  • Daily Goal setting and updating
  • Daily remainder setting and updating
  • Streak Count
  • Showing topic covered count
  • Showing lessen covered count
  • Showing new notification
  • Daily goal reached or not progress

Wireframe

The wireframes are designed using figma. You can view the wireframe by clicking here

Colors

#17A1FA #02F054 #C7D909 #F09A02 #E61902

Typography

  • Poppins
  • Roboto

Prototype

For getting details about prototype check out here

Structure the app course

To Do

  • API Development
  • Designing using jetpack compose
  • Ds And Algorithm codes - Check out the ToDo.md
  • Development
  • Unit Testing

Getting Started

Prerequisites

You need to know a basic understanding of

  • Android Fundamentals.
  • Kotlin language.
  • Clean architecture
  • Coroutines

So let's get started.

  1. Install Android studio
  2. Install Android SDK(28)

Installation

  1. Fork the repo
  2. Clone the repo
  3. Start a new project as import from Version Control in android studio and paste the clone URL and finish.
  4. Run your application.

Contributing

Contributions are always welcome! Contributions are what make the open-source project amazing. Which helps to learn, inspire, and found new modes in the development phase of a coder. Any contribution to this project is greatly appreciated. If you have any suggestion or found any issues please free to put your suggestion.

If you like to contribute to the project you can check the CONTRIBUTING.md to know how to contribute to the projet.

That's all

💭 Needed any help and how to contact

The project has also discussion section you can discuss an issue or can share your ideas. Let's make it as great

Also check out the discord to disucuss

Contributors

Made with contrib.rocks.

License

Apache license