/dscmmmut

Developer Student Clubs is a Google Developers program for university students to learn mobile and web development skills, design thinking skills, and leadership skills.

Primary LanguageJavaScriptMIT LicenseMIT

DSC MMMUT 🔥

This awesome Progressive Web App was created for Developer Student Clubs in Madan Mohan Malaviya University of Technology as a profile and a platform to showcase what they're upto in events, outreach to local businesses and showcases and most importantly their success stories to the world.

Name Source Code Demo
Light Theme GitHub Preview

Creator 👨‍💻

Usage 🛠

  • Fork repository and clone it locally
  • Customize the content inside the following files only index.html, learn.html, project.html & manifest.json
  • Publish your site
  • Share the goodness of this awesome web template by sharing it & leaving a star on the repo

Running it locally 🔩

  • You might need to have NPM or yarn
  • In the project directory, run npm install or yarn install depending on which you have
  • Then run npm run dev and open your browser to http://localhost:8080 to start working on the project
  • To build the project run npm run build

Firebase Hosting

  • Install Node.js (v8.9.4 or above)
  • launch command prompt/terminal
  • cd documents
  • git clone https://github.com/coderaky/dscmmmut
  • cd dscmmmut
  • Install project dependencies: npm install or yarn
  • Install Firebase CLI: npm i -g firebase-toolsor yarn global add firebase-tools
  • Create a new firebase project here
  • Login into Firebase CLI: firebase login
  • Type firebase init to create a firebase.json
  • Copy the static files (JS,CSS, Assets folders,index.html file) into a newly created 'Y' or 'N' folder
  • Add project from firebase console using firebase -add project-name
  • Publish firebase deploy

Improvements

  • Mobile site enhancements ✔
  • Add tutorials page ✔
  • Add projects showcase page ✔
  • Progressive Web App support ✔
  • Push notifications support 📢

Updating

Here is a git workflow for updating your fork (or downloaded copy) to the latest version:

git remote add upstream https://github.com/coderaky/dscmmmut.git
git fetch upstream
git merge upstream/dscmmmut
# resolve the merge conflicts in your editor
git add . -u
git commit -m 'Updated to the latest version'

Contributing

This Project is an open source software project and I encourage developers to contribute patches and code for us to include in the main package of this Project. All contributions will be fully credited.

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