jdidah / vibranium

:hourglass_flowing_sand: The Official Developer Student Clubs web showcase template. :tada:

Project Vibranium 🔥

This awesome Progressive Web App was created for DSC SSA Communities as a profile and a platform to showcase their success stories, upcoming and past events in pictures & event slides to the world.

Live Demo

Creators 😎

• Kelvin Kamau - DSC Kisii University Lead
• DSC Sub Saharan Africa Leads

Usage

• Fork repository and clone it locally
• Run npm i formfirejs
• Replace values inside formfire.js with your own firebase config values.

var config = {
    apiKey: "XXXXXXXXXXXXXXXXXXXXXX",
    authDomain: "XXXXXXXXXXXXXXXXXXXXXX",
    databaseURL: "XXXXXXXXXXXXXXXXXXXXXX",
    projectId: "XXXXXXXXXXXXXXXXXXXXXX",
    storageBucket: "XXXXXXXXXXXXXXXXXXXXXX",
    messagingSenderId: "XXXXXXXXXXXXXXXXXXXXXX"
};

Firebase Hosting

• Install Node.js (v8.9.4 or above)
• Install Firebase CLI: npm i -g firebase-toolsor yarn global add firebase-tools
• Install project dependencies: npm install or yarn
• Create a new firebase project here
• Login into Firebase CLI: firebase login
• Publish firebase deploy

Improvements

• Mobile site enhancements ✔
• Auto-responder after user subscribes 💯
• 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/kelvinkamau/Vibranium.git
git fetch upstream
git merge upstream/Vibranium
# resolve the merge conflicts in your editor
git add . -u
git commit -m 'Updated to the latest version'

Contributing

Project Vibranium is an open source software project and I encourage developers to contribute patches and code for us to include in the main package of Project Vibranium. 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

Versioning

This project uses semver for versioning. Current version: v1.0.0

Technology Stack

• HTML
• Bootstrap
• Firebase
• FormFireJS
• Service Worker & PWA
• Material Design Bootstrap

View Websites Built with Project Vibranium

Community Name	Location	Web App Link
DSC Kisii University	Kisii, Kenya	Live Here
DSC Taita Taveta University	Taita Taveta, Kenya	Live Here
DSC Bayero University Kano	Kano, Nigeria	Live Here

Buy us a coffee here ☕

License

Copyright (c) 2018 Project Vibranium 🔥

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.