Skip to content
:octocat: Web template for and by DSC SSA chapters because we are a Wakanda of student developers and future technology leaders from all across Africa. 🎉
HTML CSS JavaScript HCL
Branch: master
Clone or download
Latest commit 1dad1b7 Aug 13, 2019

readme.md

Vibranium

Project Vibranium 🔥

This awesome Progressive Web App was created for Developer Student Clubs in Sub Saharan Africa 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.

Build Status Codacy Badge

Name Source Code Demo
Dark Theme GitHub Preview
Light Theme GitHub Preview

Creators 👨‍💻

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/kelvinkamau/Vibranium
  • cd Vibranium
  • 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/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: v2.0.0

Websites using Project Vibranium

Community Name Location Web App Link
DSC Kisii University Kenya Live Here
DSC Taita Taveta University Kenya Live Here
DSC Bayero University Kano Nigeria Live Here
DSC Yabatech Nigeria Live Here
SemaPay Kenya Live Here
DSC University of Nairobi Kenya Live Here
DSC FUTA Nigeria Live Here
DSC IBBUL Nigeria Live 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.

FOSSA Status

You can’t perform that action at this time.