thenishantgiri / ask-score

Ask SCoRe- Community App - Ask SCoRe app is the community app, which will help organisation in Collaboration, teamwork, promotion, cooperation with their members(Mentors, Mentees, Students). Ask SCoRe application will be implemented using React-Native. This app will also use Go-Social Framework in order to create and use the components.

Ask-SCoRe

About

What Open Source Organisations aims is for more productivity, which can be achieved when the organisation's members promote, collaborates, co-operates with each other. And hence Ask-SCoRe application helps in achieving the motive.

Ask SCoRe app is the community app, which helps organisation in Collaboration, teamwork, promotion, cooperation with their members(Mentors, Mentees, Students). Ask SCoRe application is implemented using React-Native. This app also uses Go-Social Framework in order to create and use the components. This app aims to resolve queries by anyone in the organisation and let members communicate in the Forums/Channels.

Table of Contents

• Features
• Setup and run
  • Run app on iOS
  • Run app on Android
• Configure Project
• Contact

Feature

• Onboarding Screens
• Firebase Integration
• Login and register a new user
• User can ask Query and Answer others
• Topic Specific Forum Threads
• Stay updated with Medium and Github Activities

Setup and run

NOTE : XCODE / Android Studio is necessary in order to setup the project.

NOTE : This project is developed using react-native-cli, make sure to install react-native-cli in your system.

1. FORK

   Note : For this, you need to have git installed in your machine.

   • If you want to contribute to the project you will have to Fork the project on GitHub.

   CLONE

   • If you have forked the project, run the following command -

   git clone https://github.com/YOUR_GITHUB_USER_NAME/Ask-SCoRe

   • If you haven't forked the project, run the following command -

   git clone https://github.com/scorelab/Ask-SCoRe

2. Install npm Libraries by running a command given below in terminal / cmd

   npm install

Configure Project

• Rename file .env.example to .env

• Setup your project on Firebase (including firebase firestore and RTDB) and copy the credentials

• Replace the credentials in file /src/config/config.js given below-

• const firebaseConfig = {
    apiKey: process.env.REACT_APP_FIREBASE_API_KEY,
    authDomain: process.env.REACT_APP_AUTH_DOMAIN,
    databaseURL: process.env.REACT_APP_DATABASE_URL,
    projectId: process.env.REACT_APP_FIREBASE_PROJECT_ID,
    storageBucket: `${process.env.REACT_APP_FIREBASE_PROJECT_ID}.appspot.com`,
    messagingSenderId: process.env.REACT_APP_FIREBASE_MESSAGING_SENDER_ID,
    appId: process.env.REACT_APP_FIREBASE_APP_ID,
    measurementId: process.env.REACT_APP_FIREBASE_MEASUREMENTID,
  };
  

• Enable authentication using email/password in Authentication Tab of Firebase Console.

• Replace the Security Rules of Firestore and Realtime Database with given rules in the files firebase_rules/firestore.rules and firebase_rules/rtdb.rules.json respectively.

Run app on iOS

• To run the project on iOS, change the current working directory to ios using a command

  cd ios

• Then Install the Pods by running a command

  pod install

• Run Project by Command

  react-native run-ios

Run app on Android

• To run the project on Android, make sure to set JDK version <=15.

• Run the project by command

  react-native run-android

Contact

You can reach the maintainers and our community on scorelab on gitter. If you are interested in contributing to the Ask-SCoRe, we have a channel too #Go-Social, where you can ask questions and interact with the community, join with us!