Mobile - code

Documentation for the "Cocktail Culturel APP" Project

Introduction

Project Name: Cocktail Culturel APP
Description: This Android application allows the management and distribution of cultural content from various sources. The app integrates multiple services to retrieve data from different cultural platforms and services.

Installation

Prerequisites:

  • Android Studio
  • Android SDK

Instructions:

  1. Clone the repository

    git clone https://your-repository-url.git
cd Cocktail_Culturel_APP-main/NewPipe-dev

  2. Open the project in Android Studio

    • Open Android Studio.
    • Select "Open an existing Android Studio project."
    • Navigate to the NewPipe-dev directory and open it.

  3. Set up dependencies

    • Ensure all required dependencies are installed by following Android Studio's instructions.

  4. Build and run the application

    • Connect your Android device or set up an emulator.
    • Click on "Run" to compile and run the application.

Project Structure

Cocktail_Culturel_APP-main/
│
├── NewPipe-dev/
│   ├── app/
│   │   ├── src/
│   │   │   ├── main/
│   │   │   │   ├── java/
│   │   │   │   │   └── org/
│   │   │   │   │       └── cocktailculturel/
│   │   │   │   │           └── app/
│   │   │   │   │               └── [source files]
│   │   │   │   ├── res/
│   │   │   │   │   └── [resource files]
│   │   │   │   ├── AndroidManifest.xml
│   │   │   ├── test/
│   │   │   ├── androidTest/
│   │   ├── build.gradle
│   │   └── proguard-rules.pro
│   ├── build.gradle
│   ├── gradle.properties
│   ├── gradlew
│   ├── gradlew.bat
│   ├── settings.gradle
│   └── [other project files]

Code Details

MainActivity.java

package org.cocktailculturel.app;

import android.os.Bundle;
import androidx.appcompat.app.AppCompatActivity;

public class MainActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
    }
}

AndroidManifest.xml

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="org.cocktailculturel.app">

    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/AppTheme">
        <activity android:name=".MainActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>

</manifest>

Main Features

  • Displaying Cultural Content: The app displays a list of cultural content from various sources.
  • Search: Users can search for specific content.
  • Favorites: Users can add content to their favorites for quick access.

Resources

Strings (strings.xml)

<resources>
    <string name="app_name">Cocktail Culturel</string>
</resources>

Colors (colors.xml)

<resources>
    <color name="colorPrimary">#6200EE</color>
    <color name="colorPrimaryDark">#3700B3</color>
    <color name="colorAccent">#03DAC5</color>
</resources>

Tests

Run the tests:

./gradlew test
./gradlew connectedAndroidTest

Deployment

Deployment Instructions:

  1. Generate the APK

    • In Android Studio, go to Build > Build Bundle(s) / APK(s) > Build APK(s).
    • The APKs will be generated in the app/build/outputs/apk/ directory.

  2. Sign the APK

    • Use Android Studio to sign the APK with a production key.

  3. Deploy to the Play Store

    • Follow the Google Play Console instructions to deploy the signed APK.

Contribution

How to contribute:

  • Fork the repository.
  • Create a branch for your feature (git checkout -b feature/my-feature).
  • Commit your changes (git commit -m 'Add my feature').
  • Push the branch (git push origin feature/my-feature).
  • Open a pull request.

Clarifications

This documentation was generated by ChatGPT, so there may be some inaccuracies. If you find any, please let me know for correction.

GitLab

https://gitlab.com/cocktail-culturel/cocktail_culturel_app-main

Documentation du Projet "Cocktail Culturel APP"

Introduction

Nom du Projet : Cocktail Culturel APP
Description : Cette application Android permet de gérer et de distribuer des contenus culturels provenant de différentes sources. L'application intègre plusieurs services pour récupérer des données de diverses plateformes et services culturels.

Installation

Prérequis :

  • Android Studio
  • SDK Android

Instructions :

  1. Cloner le dépôt

    git clone https://votre-url-de-depot.git
cd Cocktail_Culturel_APP-main/NewPipe-dev

  2. Ouvrir le projet dans Android Studio

    • Ouvrez Android Studio.
    • Sélectionnez "Open an existing Android Studio project".
    • Naviguez jusqu'au répertoire NewPipe-dev et ouvrez-le.

  3. Configurer les dépendances

    • Assurez-vous d'avoir installé toutes les dépendances requises en suivant les instructions d'Android Studio.

  4. Construire et exécuter l'application

    • Connectez votre appareil Android ou configurez un émulateur.
    • Cliquez sur "Run" pour compiler et exécuter l'application.

Structure du Projet

Cocktail_Culturel_APP-main/
│
├── NewPipe-dev/
│   ├── app/
│   │   ├── src/
│   │   │   ├── main/
│   │   │   │   ├── java/
│   │   │   │   │   └── org/
│   │   │   │   │       └── cocktailculturel/
│   │   │   │   │           └── app/
│   │   │   │   │               └── [source files]
│   │   │   │   ├── res/
│   │   │   │   │   └── [resource files]
│   │   │   │   ├── AndroidManifest.xml
│   │   │   ├── test/
│   │   │   ├── androidTest/
│   │   ├── build.gradle
│   │   └── proguard-rules.pro
│   ├── build.gradle
│   ├── gradle.properties
│   ├── gradlew
│   ├── gradlew.bat
│   ├── settings.gradle
│   └── [other project files]

Détails du Code

MainActivity.java

package org.cocktailculturel.app;

import android.os.Bundle;
import androidx.appcompat.app.AppCompatActivity;

public class MainActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
    }
}

AndroidManifest.xml

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="org.cocktailculturel.app">

    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/AppTheme">
        <activity android:name=".MainActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>

</manifest>

Fonctionnalités Principales

  • Affichage des Contenus Culturels : L'application permet d'afficher une liste de contenus culturels provenant de différentes sources.
  • Recherche : Les utilisateurs peuvent rechercher des contenus spécifiques.
  • Favoris : Les utilisateurs peuvent ajouter des contenus à leurs favoris pour un accès rapide.

Ressources

Strings (strings.xml)

<resources>
    <string name="app_name">Cocktail Culturel</string>
</resources>

Couleurs (colors.xml)

<resources>
    <color name="colorPrimary">#6200EE</color>
    <color name="colorPrimaryDark">#3700B3</color>
    <color name="colorAccent">#03DAC5</color>
</resources>

Tests

Exécuter les tests :

./gradlew test
./gradlew connectedAndroidTest

Déploiement

Instructions de déploiement :

  1. Générer l'APK

    • Dans Android Studio, allez dans Build > Build Bundle(s) / APK(s) > Build APK(s).
    • Les APK seront générés dans le répertoire app/build/outputs/apk/.

  2. Signer l'APK

    • Utilisez Android Studio pour signer l'APK avec une clé de production.

  3. Déployer sur le Play Store

    • Suivez les instructions de Google Play Console pour déployer l'APK signé.

Contribution

Comment contribuer :

  • Forker le dépôt.
  • Créer une branche pour votre fonctionnalité (git checkout -b feature/ma-feature).
  • Commiter vos changements (git commit -m 'Ajout de ma feature').
  • Pousser la branche (git push origin feature/ma-feature).
  • Ouvrir une pull request.

Précisions

Cette documentation a été générée par ChatGPT, il se peut qu'il y ait quelques imprécisions, si c'est le cas merci de me le signaler pour correction.

Gitlab

https://gitlab.com/cocktail-culturel/cocktail_culturel_app-main