Skip to content

Latest commit

 

History

History
187 lines (151 loc) · 7.84 KB

README.md

File metadata and controls

187 lines (151 loc) · 7.84 KB
Raw

Aura - GDG[x]

MadeWithVueJs.com shield Build Status

Standard Web App for GDG's Communties.
Demo
Version: 1.0.6

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

Overview

Aura is the website template that helps you to set GDG's Communities website with events, team and management in a few minutes.

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

Features

Feature Description
Fast and optimized PWA on Lighthouse
Works offline Can works 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 keep and update all information in the JSON File

Getting Started

  1. Fork repository and clone it locally
  2. Install project dependencies: npm install
  3. Replace the urlname Field (CHAPTER_URL_NAME) here
  4. Compiles and hot-reloads for development: npm run serve
  5. Update Meta Tag, Title Tag and Google Analytics Code from Basic Info, manifest.json and Resources
  6. For the production: npm run build and then one dir will be created dist
  7. For testing: npm run test

Deploy on Firebase

  1. Setup Environment for the Firebase deployment
    • Install Firebase CLI: npm i -g firebase-tools
  2. Create Firebase account and login into Firebase CLI: firebase login
  3. Open Terminal/CMD/Powershell in your dir.
  4. Now type firebase login command in your Terminal/CMD/Powershell.
  5. Type firebase init.
  6. Select the project by using the arrow keys.
  7. Then Select the Firebase Hosting by using Spacebar and arrow key.
  8. Click No for Single page web app.
  9. Type dist.
  10. Some by default file will be created successfully.
  11. Run locally
    • firebase serve or npm run serve
  12. Update Firebase.json file 
        {
        "hosting": {
            "public": "dist",
            "rewrites": [ {
                "source": "**",
                "destination": "/index.html"
            } ],
            "ignore": [
                "firebase.json",
                "**/.*",
                "**/node_modules/**"
            ]
        }
    }
  13. Build and deploy
    • firebase deploy or npm run deploy

Deploy on Netlify

  1. On Netlify, setup up a new project from GitHub with the following settings:

    • Build Command: npm run build or yarn build
    • Publish directory: dist

  2. Hit the deploy button!

Also checkout vue-cli-plugin-netlify-lambda.

In order to receive direct hits using history mode on Vue Router, you need to create a file called _redirects under /public with the following content:

# Netlify settings for single-page application
/*    /index.html   200

More information on Netlify redirects documentation.

Run your tests

  1. For Test: npm run test

Lints and fixes files

  1. For Lints and Fixes files: npm run lint

Documentation

  1. The Getting Started guide is probably a good first point of call!
  2. Full documentation.

Customize configuration

See Configuration Reference.

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

Contributors

Maintainer: Vrijraj Singh

View Website Built with Projects

Community Name Web App Link
GDG Jalandhar View Now
GDG Kuala Lumpur View Now
GDG Fortaleza View Now
GDG Kozhikode View Now
GDG Delta View Now
GDG Tokyo View Now
GDG Yangon View Now
GDG Gran Canaria View Now
GDG Santander View Now
GDG Ciudad del Este View Now
GDG Ilorin View Now
GDG Chetumal View Now
GDG Porto View Now
GDG Istanbul View Now
GDG Port-of-Spain View Now
GDG Jeddah View Now
GDG Sevilla View Now
GDG Madeira View Now
GDG Chandigarh View Now
GDG Rochester View Now
GDG Sri Lanka View Now
GDG Lafia View Now
GDG Kinshasa View Now
Dev Cluster Goa View Now
GDG Cloud Calgary View Now
GDG Cloud SF View Now
GDG Nagpur View Now
GDG Kolkata View Now
GDG Ahmedabad View Now
GDG Fremont View Now
GDG Savannah View Now
GDG San Salvador View Now
GDG Indore View Now
GDG Pescara View Now
GDG CDE View Now
GDG Galicia View Now
GDG Campobasso View Now
GDG Galway View Now
GDG Nizhny Novgorod View Now
GDG Madurai View Now
GDG Bristol View Now
GDG Ranchi View Now
GDG Chennai View Now
GDG Kano View Now
GDG Gandhinagar View Now

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