Skip to content

xprilion/aura-admin

 
 

Repository files navigation

Aura Admin

Version: 3.1.1
Demo: [Click Here](https://auradmin.web.app/)

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

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
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. 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. In the Firebase project console dashboard. Click on create a new app
  9. Go to Firebase project Settings and then General Settings Tab
  10. Scroll down and go to your app section under Firebase SDK snippet
  11. Now click on the node
  12. Copy the code
    apiKey: "Axxxxxxxxxxxxxxxxxxx",
    authDomain: "xxxxxx.firebaseapp.com",
    databaseURL: "https://xxxxxxxx.firebaseio.com",
    projectId: "xxxxxxxxx",
    storageBucket: "xxxxxxx.appspot.com",
    messagingSenderId: "xxxxxxxxxxx",
    appId: "1:xxxxxxxxx:web:xxxxxxx"
  13. Firebase console and got to Authentication, select Sign in method as a email and Password
    • Create user with Email and Password
  14. Now goto project code and inside src/config/ update the firebase.js file with these codes
  15. Update the field name in vue.config
  16. Run locally npm run serve
  17. For the production: npm run build and then one dir will be created dist
  18. For testing: npm run test

Push Notification Setup

  1. Go to Firebase Project Dashboard
  2. Go to Firebase Projects Settings then Cloud Messaging
  3. Copy the server key and go to Aura Admin Config page then Keys & Securities and paste the code at Cloud Messanging Server Key field
  4. Go to Firebase Project Settings then Cloud Messaging and Web configuration section and click on generate Key pair and Copy and go to Aura Admin Config page then Keys & Securities and paste the code at Cloud Messaging Web Push certificate field
  5. Save the Config
  6. For Sending Push Notification from Aura Admin, Goto Notification and then click on Add Notification and then click on Send Push Notification Button in Table

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

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 :)

About

Aura Admin to Manage the Aura Web app.

Resources

License

Code of conduct

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Vue 92.8%
  • JavaScript 6.8%
  • Other 0.4%