Skip to content
This repository has been archived by the owner on Jan 10, 2025. It is now read-only.
E. Brink edited this page Oct 2, 2023 · 9 revisions

Introduction

Welcome to the belindas-closet-android wiki!


Development

This section outlines the development environment and practices.


Git Branching Strategy

The text may be hard to read so a pdf is available for download below the picture allowing developers to zoom in and read the notes. Also, you can right-click and open in a new tab.

GitHub Flow Branching Strategy GitHub Flow Branching Strategy.pdf


Belinda's Closet Mobile App Layout

This is intended to guide people in the conceptual structure of the app navigation and illustrate where connections to the nest.js api endpoints will be needed. The text may be hard to read so a pdf is available for download below the picture allowing developers to zoom in and read the notes. Also, you can right-click and open in a new tab.

Coming soon!


Purpose

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.

Technologies

  • Android Studio
  • Kotlin

Collaboration

The repository is open for contributions and aims to be a collaborative effort among students and faculty. TODO: Information on how to collaborate on this project.


Configuration

Environment Variables

Details about the environment variables used in the project.

Authentication Configuration

Information on configuring authentication features.


Contributors

Summer 2023 100-Day Project Team

Fall 2023 Student Contributors

Special Thanks


Installation

Details on how to install the app.

Prerequisites

  • Android Studio
  • JDK 8 or higher

Steps

  1. Clone the repository

git clone https://github.com/SeattleColleges/nsc-events-android.git

  1. Open the project in Android Studio.
  2. Sync Gradle and build the project.
  3. Run the app on an emulator or physical device.

Tests

Information on the types of tests available.

Prerequisites

  • Android Studio
  • Emulator or physical device

Running Unit Tests

Instructions for running unit tests.

Running Snapshot Tests

Instructions for running snapshot tests.

Running Test Coverage

Instructions for running test coverage reports.


Usage

Information on how to use the app.

Starting the Application

Instructions for starting the application.

Connecting to Nest.js Backend

To successfully connect the Android app to the backend, make sure the Nest.js application is running on port 3000. This is crucial for the Android app to fetch data and perform other backend-related tasks.

Clone this wiki locally