Git Product home page Git Product logo

fosscu-app's Introduction

FOSSCU App

Welcome to FOSSCU APP! A mobile app made for FOSS-Community.

Features

  • FOSSCU Events: Register for tech events organized by FOSSCU directly from our app.
  • FOSS-Community Updates: Get all the updates of FOSS-Community right at your finger tips.
  • Resources: Hand Curated resources to kickstart your coding journey.
  • Create your FOSSCU Account: With our FOSSCU Account on FOSSCU App and claim XPs.

Screenshots

Below are some screenshots showcasing different parts of the app.

Screenshot 1 Screenshot 2 Screenshot 3 Screenshot 4 Screenshot 4 Screenshot 4 Screenshot 4

Getting Started

Prerequisites

Installation on Local

To get started with FOSSCU App, follow these steps:

Clone the Repository:

```bash
git clone https://github.com/FOSS-Community/fosscu-app.git
cd fosscu_app
```

Install Dependencies: bash flutter pub get

Creating A Personal access token for GitHub APIs

Setting up Airtable

  • Create an account on Airtable

  • Create a personal access token PAT

  • Create a new base inside a workspace

  • Under that base create a new table

  • Inside the lib/constants create a new file named apikey.dart

    const apikey = 'your_github_personal_access_token;
    const airtablePAT = 'your_airtable_personal_access_token';
    const baseID = 'your_airtable_base_id';
    const table = 'your_airtable_table_id'; 
    
    

Setting up Firebase

  • Go to the Firebase Console.

  • Click on "Add Project" and follow the setup steps.

  • Install Firebase CLI npm install -g firebase-tools

  • Install FlutterFire CLI - dart pub global activate flutterfire_cli

  • run firebase login

  • run flutterfire configure

  • Select the Firebase project that you just created on the Firebase Console.

  • Now go to Firebase Console and

    1. Enable Authentication with Google as Sign in Provider
    2. Create a new Firestore Database
  • Create a new Debug SHA-1 and SHA-256 Keys Guide

  • Go to the Project Settings on the Firebase Console and the SHA-1 and SHA-256 Keys in the SHA Certificate Fingetprint Section.

Now we are all set to run the app locally

Running the App

  1. Connect a Device: Connect an Android or iOS device, or start an emulator.
  2. Build and Run:
    flutter run

How to become an admin user of the app?

  • Go to your Firestore Database
  • Create a new collection named admin
  • Create a new document named admin_right inside the admin collection.
  • Add a new String type field inside the document with the email you want the admin access.
    • example:
    Field: admin1
    Type: string
    Value: [email protected]
    

Contributing

We welcome contributions to the FOSSCU App! Please follow these steps to contribute:

  1. Fork the repository.
  2. Create a new branch:
    git checkout -b feature/your-feature-name
  3. Make your changes and commit them:
    git commit -m "Add new feature"
  4. Push to the branch:
    git push origin feature/your-feature-name
  5. Open a pull request.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.