This repository was archived by the owner on Jan 10, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
fea38e0
commit 6d67193
Showing
1 changed file
with
53 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,56 @@ | ||
# Belinda's Closet | ||
# Belinda's Closet Android Application Introduction | ||
<!-- Brief description of the project with the inclusion of a mention about the android and web app aspect. --> | ||
In the fall quarter of 2022 Belinda's Closet opened as a response to students' need for graduation day clothing. Belinda's Closet has since grown to also include professional clothing appropriate for interviews and work. The objective of this application is to give staff the ability to edit Belinda's Closet inventory as well as give the students the ability to search the inventory. This application will be available on both [desktop](https://github.com/SeattleColleges/belindas-closet-nextjs) and [mobile](https://github.com/SeattleColleges/belindas-closet-android) devices. | ||
In the fall quarter of 2022 Belinda's Closet opened as a response to students' need for graduation day clothing. Belinda's Closet has since grown to also include professional clothing appropriate for interviews and work. The objective of this application is to give staff the ability to edit Belinda's Closet inventory as well as give the students the ability to search the inventory. This application will be available on both [desktop](https://github.com/SeattleColleges/belindas-closet-nextjs) and [mobile](https://github.com/SeattleColleges/belindas-closet-android) devices. The backend is accessible [here](https://github.com/SeattleColleges/belindas-closet-nestjs). | ||
|
||
--- | ||
|
||
## Table of Contents | ||
|
||
- [What’s Under the Hood](#whats-under-the-hood) | ||
- [Wiki](#wiki) | ||
|
||
--- | ||
|
||
## What's Under the Hood | ||
|
||
This section dives deeper into the technical aspects of the application, focusing on the choices made and the technologies employed. It serves as a reference point for developers interested in the app's inner workings. | ||
|
||
--- | ||
|
||
### Software & Tools Used | ||
|
||
Development Environment: | ||
* Integrated Development Environment (IDE): Android Studio | ||
* Android Studio: The integrated development environment used to build, debug, and test the application. | ||
* Version Control System (VCS): Git | ||
* Build System: Gradle | ||
* Gradle: The build automation tool used to manage dependencies, compile code, and build the app. | ||
* Gradle plugins for Kotlin and Jetpack Compose. | ||
Programming Languages: | ||
* Primary Language: Kotlin | ||
* The primary programming language chosen for its conciseness, expressiveness, and safety features. | ||
Libraries and Frameworks: | ||
* Jetpack Compose | ||
* The modern UI framework used to build the app's user interface, offering a declarative and reactive approach. | ||
Testing Tools: | ||
* Unit Testing Framework: JUnit | ||
* Covers the business logic and functionality of the app. | ||
Additional Tools: | ||
* CI/CD Platform: Github Actions | ||
* Integration with Github Actions CI/CD to automate builds and deployments. | ||
Documentation Tools: | ||
* Wiki or Knowledge Base: GitHub wiki | ||
|
||
--- | ||
|
||
### Installation Instructions | ||
(as needed) | ||
|
||
--- | ||
|
||
## Wiki | ||
- Visit our [Wiki](https://github.com/SeattleColleges/belindas-closet-android/wiki) for more information about style and formatting. | ||
|
||
## Team Members | ||
- BC Ko, instructor and advisor | ||
- Brandon Dombrowsky, Technical Program Manager | ||
- E. Brink, Technical Project Manager | ||
- Taylor Papke, Product Owner | ||
- Gary Larson, Lead Developer | ||
- Tin Pham, Full Stack Developer | ||
- Robel Hailu, Full Stack Developer | ||
- New team members TBA! | ||
|
||
## Acknowledgements | ||
- Thank you, BC! | ||
- Thank you, Belinda! | ||
- Visit our [Wiki](https://github.com/SeattleColleges/belindas-closet-android/wiki) to learn more about: | ||
- General Infrastructure | ||
- Style | ||
- Formatting | ||
- The Development Team |