Skip to content

Latest commit

 

History

History
203 lines (174 loc) · 9.57 KB

README.md

File metadata and controls

203 lines (174 loc) · 9.57 KB
Raw

Aura Admin

Version: 3.1.1

Click Here

Show some ❤️ and ⭐ the repo to support the project

If you are using Aura, Kindly fill this form for Aura Web App Directory

Overview

Aura Admin is the Web App that helps you to mange the Tech Communities like GDGs, DSCs or any other tech communities.

The template is created by GDG Jalandhar team experience of running meetups/events.

Features

Feature Description
Fast and optimized PWA on Lighthouse
Works offline Can work offline
Mobile first Mobo Friendly Web app can be installed as a native app on your phone
SEO optimized index all content and get to the top in search results
Easy in management Store all the data in Cloud Firestore
Trigger Push Notification Trigger Push Notification to Aura Main
User Management Role based Authentication for the Team
Connect Team Member can communicate in Group
Usability Any Tech Communities can use

Getting Started

  1. Fork this repository & Aura Main (Important) and clone both repo locally
  2. Setup Environment
  3. Install project dependencies: npm install
  4. If you already have setup Aura Main then use same Firebase Project
  5. Otherwise Create Firebase account and Create a new Project
  6. Go to Firebase Project Dashboard
  7. Go to Cloud Firestore Database and Enable the database in test mode
  8. Once the database is created, Click on Rules navigation pill and add the following lines in the rules edit 
        rules_version = '2';
    service cloud.firestore {
        match /databases/{database}/documents {
            match /apiEnd/{apiEndpoint}{
                allow read, create : if true;
              allow delete : if request.auth.uid != null;
              allow update : if request.auth.uid != null;
              allow list: if request.auth.uid != null;
            }
            match /{document=**} {
              allow read : if true;
              allow delete : if request.auth.uid != null && get(/databases/$(database)/documents/users/$(request.auth.uid)).data.userType == "Super Admin";
              allow create : if request.auth.uid != null;
              allow update : if request.auth.uid != null;
            }
        }
    }
  9. Go to Firebase Storage
  10. Copy the code which looks similar to the below sample and update the rule for Firebase Storage 
    service firebase.storage {
  match /b/{bucket}/o {
    match /{allPaths=**} {
      allow read, write: if request.auth != null;
    }
  }
}
  11. In the Firebase project console dashboard. Click on create a new app
  12. Go to Firebase project Settings and then General Settings Tab
  13. Scroll down and go to your app section under Firebase SDK snippet
  14. Click on node/config radio select
  15. Copy the code which looks similar to the below sample 
    apiKey: "Axxxxxxxxxxxxxxxxxxx",
authDomain: "xxxxxx.firebaseapp.com",
databaseURL: "https://xxxxxxxx.firebaseio.com",
projectId: "xxxxxxxxx",
storageBucket: "xxxxxxx.appspot.com",
messagingSenderId: "xxxxxxxxxxx",
appId: "1:xxxxxxxxx:web:xxxxxxx"
  16. Now goto project code on your local system and inside src/config/ update the firebase.js file with the code you copied from the Firebase console and Update the field name in vue.config in the local project root directory
  17. Click on Authentication in the left navigation.
  18. Click on Sign-in method and enable Email/Password
    • Create user with Email and Password
  19. For Cloud Functions
    • npm install for installing dependencies
    • Goto src/functions and then in the terminal run this command 
          firebase functions:config:set someservice.email="[email protected]" someservice.password="yourpassword"
  20. Run locally npm run serve
  21. When you are ready to build for production, use the following command -
    • npm run build
    • A directory named dist will be created
  22. For testing: npm run test

Push Notification Setup

  1. Go to Firebase Project Dashboard
  2. Go to Firebase Projects Settings then navigate to Cloud Messaging
  3. Copy the server key
  4. Go to your Aura Admin Dashboard and paste at the server key at Config -> Keys & Securities as Cloud Messaging Server Key
  5. Again, in the Firebase Project Dashboard, go to Projects Settings -> Cloud Messaging and scroll down to the Web configuration section and click on Generate Key pair
  6. Copy the generated key and Paste it at Aura Admin Dashboard’s Config -> Keys & Securities as Cloud Messaging Web Push certificate
  7. Save the Config by clicking on Save Keys and Security
  8. For Sending Push Notification from Aura Admin Dashboard
    • Go to Notification
    • Click on Add Notification
    • Fill fields as required
    • Click on Send Push Notification Button in Table

Deployment on Firebase

  1. Install required tools for performing Firebase deployment
    • Install Firebase CLI: npm i -g firebase-tools
  2. Login into Firebase CLI using the following command - firebase login
  3. Open Terminal/CMD/Powershell in the root directory of your clone of aura-admin repository.
  4. Now type firebase login command in your Terminal/CMD/Powershell
  5. Update the Firebase Project ID in .firebasesrc file. This value should match the project ID in your Project Settings of the Firebase project you created in the previous section.
  6. Go to the Firebase Console Dashboard and Click on Hosting in the left navigation.
  7. Click on Get Started
  8. Click through all steps till you’re taken to the Hosting page in the console.
  9. You’ll be provided with a ready domain with your project ID. It should look like - <project-id>.web.app or <project-id>.firebaseapp.com
  10. Copy the sub-domain name of the URL provided. In this case, it will be the project ID. However, to be precise, you have to copy the part before .web.aap or .firebaseapp.com. This is your Site ID
  11. Update Firebase.json file, set the site key to Site ID 
        {
        "hosting": {
            "site":"Your_Firebase_Hosting_id",
            "public": "dist",
            "rewrites": [ {
                "source": "**",
                "destination": "/index.html"
            } ],
            "ignore": [
                "firebase.json",
                "**/.*",
                "**/node_modules/**"
            ]
        }
    }
  12. In your terminal at the root directory of the project, build and deploy using the following command
    • firebase deploy
  13. Google LessSecure App open this link and enable Less secure app access Also Allow access to your Google account from this url
  14. If the project is successfully deployed, you should be able to visit your domain as found, and see the Aura Admin Dashboard. In future, we’ll refer to this website as your Aura Admin Dashboard.

Documentation

  1. Full documentation.

Technology Stack

Contributing

Awesome! Contributions of all kinds are greatly appreciated. To help smoothen the process we have a few non-exhaustive guidelines to follow which should get you going in no time.

Using GitHub Issues

  • Feel free to use GitHub issues for questions, bug reports, and feature requests
  • Use the search feature to check for an existing issue
  • Include as much information as possible and provide any relevant resources (Eg. screenshots)
  • For bug reports ensure you have a reproducible test case
  • A pull request with a breaking test would be super preferable here but isn't required

Submitting a Pull Request

  • Squash commits
  • Lint your code with eslint (config provided)
  • Include relevant test updates/additions
  • Pull requests must be made against develop branch. Any other branch (unless specified by the maintainers) will get rejected.

Contributors

Maintainer: Vrijraj Singh
Developers: Vrijraj Singh & Bharat Agarwal

View Website Built with Projects

Community Name Web App Link
GDG Jalandhar View Now
DSC NSEC View Now
DSC VJIT View Now

Facing Any Problem or need any Help?

Write us in issues section. Our team will try solve your issue within 10-12 hours.

Project is published under the MIT license.
Feel free to clone and modify repo as you want, but don't forget to add reference to authors :)