Skip to content

Latest commit

 

History

History
68 lines (40 loc) · 2.19 KB

README.md

File metadata and controls

68 lines (40 loc) · 2.19 KB

Academic Pulse

Academic Pulse is an open-source Android application tailored for academic researches to share their scientific publications.

Overview

Tech Stack

  • Kotlin: The primary language for the application, ensuring modern, concise, and safe code.
  • Jetpack Compose: Used for creating a responsive and scalable UI with Kotlin, facilitating a declarative approach to UI development.
  • Firebase: Backend services including Authentication, Firestore database, and Cloud Functions for robust and scalable data management.

Features

  • Open Source: Contributions are welcome! Fork the repository and make your own improvements.
  • User-Friendly Interface: Built with Jetpack Compose for a seamless user experience.
  • Real-Time Data Management: Powered by Firebase, ensuring efficient data handling and real-time updates.

Getting Started

Prerequisites

Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/AcademicPulse.git

  2. Open the project in Android Studio.

  3. Configure Firebase:

    • Add the google-services.json file from your Firebase project
    • It should be exactly in this location ./academicpulse/app/google-services.json
    • Follow this guide Add Firebase to your Android project

  4. Build and Run:

    • Build the project and run it on an emulator or physical device

Documentation

Kotlin documentation

Jetpack Compose documentation

Firebase documentation For Android

Firebase Console

Contribution

  1. Fork the repository.

  2. Create a new branch (git checkout -b feature-branch).

  3. Commit your changes (git commit -m 'Add some feature').

  4. Push to the branch (git push origin feature-branch).

  5. Open a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.