Git Product home page Git Product logo

devfest-website-2023's Introduction

DevFest Web App 2023

Standard Web App for DevFest's Events.
Show some ❤️ and star the repo to support the project

image

Getting Started

  1. Fork the repo
  2. Setup Environment
  3. Install project dependencies: npm install
  4. Compiles and hot-reloads for development use npm run serve
  5. Update JSON files from src/assets/data directory
  6. Upload all the images related to Speakers, Team and Sponsors in src/assets/img with their respective directory
  7. Update meta tags, Google Analytics and other info in public/index.html file.
  8. For the production: npm run build and then one dir will be created dist

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 the 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

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

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.

Customize configuration

See Configuration Reference.

Contributors

Maintainer: Vrijraj Singh

View Website Built with Projects

Community Name Web App Link
GDG X View Now

LICENSE

Check out the developer LICENSE

Facing Any Problem or need any Help?

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

devfest-website-2023's People

Contributors

vrijraj avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

devfest-website-2023's Issues

Newbie here must be missing a step

Screenshot 2023-09-20 at 5 00 40 PM
Hi Vrijraj, I've tried to recreate this website following your README. I have not made any content changes yet but wanted to practice getting everything pulled over and deployed with Firebase since this is well outside my normal expertise. However, once I do firebase deploy it just leads to a page like in the screenshot. Not sure what I've done.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.