Skip to content

GDG-Addis/DevFest

Repository files navigation

DevFest WebApp Site

A Standard WebApp for the annual developers festival, #DevFest.
Live
Version: 1.0.1

Overview

DevFest WebApp is a progressive web app platform that helps GDG Addis's Community easily follow up with the Developer Festival Activities such as Agenda, Speakers, Codelabs and more.
The template is created by GDG Jalandhar team and Here is the original repository.

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. Find the Meetup API Key and paste it here, also replace the chapter URL from Meetup.com/[gdg-chapter-url]
  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 your Web App 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

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

Special Thanks

original Maintainer: Vrijraj Singh

Feel free to clone and modify repo as you want, but don't forget to add reference to authors :)