Sisu is an Android application built with Java and Firebase. The name "Sisu" is a Nepali term referring to a child or a newborn. This project serves as a foundational template for an application requiring robust user authentication, database services, and cloud storage, allowing users to manage their data effectively.
Note to Developers: This README provides a general overview
Currently, the Sisu application includes the following core features:
- User Authentication:
- User registration with email and password.
- User login.
- Leverages Firebase Authentication for secure user management.
- Data Persistence:
- Integrated with Firebase Firestore for NoSQL cloud database storage. (Further implementation for specific data models is pending).
- File Storage:
- Integrated with Firebase Cloud Storage for storing user-generated content like images, documents, etc. (Further implementation for specific file handling is pending).
- Splash Screen: A simple startup screen.
- Programming Language: Java
- Platform: Android
- Backend Services (Firebase):
- Firebase Authentication
- Firebase Firestore
- Firebase Cloud Storage
- Build Tool: Gradle
- Android Libraries:
- AndroidX AppCompat
- Google Material Components
- AndroidX ConstraintLayout
The project follows a standard Android Gradle structure:
Sisu/
├── app/
│ ├── src/
│ │ ├── main/
│ │ │ ├── java/com/sanjit/sisu/ # Core Java source files (Activities, etc.)
│ │ │ │ ├── Login.java
│ │ │ │ ├── MainActivity.java
│ │ │ │ ├── Register.java
│ │ │ │ └── SplashScreen.java
│ │ │ ├── res/ # Resources (layouts, drawables, strings, etc.)
│ │ │ │ ├── layout/ # XML layout files for activities
│ │ │ │ │ ├── activity_login.xml
│ │ │ │ │ ├── activity_main.xml
│ │ │ │ │ ├── activity_register.xml
│ │ │ │ │ └── activity_splash_screen.xml
│ │ │ │ ├── values/ # Strings, colors, styles
│ │ │ │ └── mipmap/ # App icons
│ │ │ └── AndroidManifest.xml # App's main configuration file
│ │ ├── androidTest/ # Instrumentation tests
│ │ └── test/ # Unit tests
│ ├── build.gradle # App-level Gradle build script
│ └── google-services.json # Firebase configuration file (NEEDS REPLACEMENT)
├── gradle/ # Gradle wrapper files
├── build.gradle # Project-level Gradle build script
├── gradlew # Gradle wrapper script (Linux/Mac)
├── gradlew.bat # Gradle wrapper script (Windows)
└── settings.gradle # Gradle settings
To get the Sisu project up and running on your local machine for development and testing purposes, follow these steps:
- Android Studio: Ensure you have the latest version of Android Studio installed. (Recommended: Arctic Fox or newer).
- Java Development Kit (JDK): JDK 8 or higher is required.
- Firebase Account: You will need a Firebase account to connect the app to its backend services.
-
Clone the Repository:
git clone <repository-url> cd Sisu
-
Set up Firebase:
- Go to the Firebase Console.
- Create a new Firebase project (or use an existing one).
- Add an Android app to your Firebase project:
- Use
com.sanjit.sisuas the package name. - You can provide a nickname for the app (e.g., "Sisu Android").
- Download the
google-services.jsonfile provided by Firebase.
- Use
- Crucial: Replace the placeholder
app/google-services.jsonfile in this project with thegoogle-services.jsonfile you just downloaded from your Firebase project.
-
Open in Android Studio:
- Open Android Studio.
- Select "Open an Existing Project" and navigate to the cloned
Sisudirectory. - Android Studio will automatically sync the Gradle project. This might take a few minutes.
-
Build and Run:
- Once Gradle sync is complete, you can build and run the app on an Android emulator or a physical device.
- Select a run configuration (usually
appby default) and click the "Run" button (green play icon).
Contributions are welcome! If you'd like to contribute to the Sisu project, please follow these steps:
- Fork the repository.
- Create a new branch for your feature or bug fix:
git checkout -b feature/your-feature-name
- Make your changes.
- Commit your changes with a clear and descriptive commit message:
git commit -m "feat: Implement amazing feature" - Push your changes to your forked repository:
git push origin feature/your-feature-name
- Open a Pull Request against the main repository.
Please ensure your code adheres to the project's coding standards (if any are established) and include tests for new features where applicable.
This project is licensed under the MIT License. See the LICENSE file for details. (You will need to create a LICENSE file and add the MIT License text if you choose this license).