Skip to content

Latest commit

 

History

History
151 lines (118 loc) · 6.84 KB

README.md

File metadata and controls

151 lines (118 loc) · 6.84 KB
Raw

Aura v3

MadeWithVueJs.com shield

Standard Web App for Tech Communties.
Demo
Version: 3.1.2

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 is the Web App that helps you to mange the Tech Communities like GDGs, DSCs or any other tech communities with Aura Admin.

Features

Feature Description
Fast and optimized PWA on Lighthouse
Works offline Can work offline
Dark/Light Theme Mode Light/Dark Theme Mode
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 Easy in Management by using Aura Admin
Usability Any Tech Communities can use
Custom Event Page Now No need to create the website for XYZ event
Public shareable URL for Team & Speakers Team member public URL for Self Branding and Public Speaker Directory & Public URL for Promotion

Contributors

Maintainer:

  1. Vrijraj Singh
  2. Bharat Agarwal

Getting Started

NOTE: Kindly Setup Aura Admin first

  1. Fork this repository & Aura Admin (Important) and clone both repo locally 1 To Setup Aura Main follow this and to setup Aura Admin
  2. Use same Firebase account project for both Admin & Aura Main
  3. Setup Environment
  4. Install project dependencies: npm install
  5. Kindly use same firebase project Aura Admin for Aura Main as well
  6. In the Firebase project console dashboard. Click on create new web app
  7. Go to Firebase project Settings and then General Settings Tab
  8. Scroll down and go to your app section under Firebase SDK snippet
  9. Now click on the config
  10. 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"
  11. Now goto project code and inside src/config/ update the firebase.js file with these codes
  12. Update the field name in vue.config
  13. Run locally
    • npm run serve
    • For the First Time you will see a text Either Your Internet is not Working or Site is not Configured
  14. For the production: npm run build and then one dir will be created dist
  15. For testing: npm run test

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

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.

View Website Built with Projects

Community Name Web App Link
GDG Jalandhar View Now
DSC NSEC View Now
GDG Konya 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.