generated from kelvinkamau/Vibranium
-
-
Notifications
You must be signed in to change notification settings - Fork 1
/
readme.md
126 lines (103 loc) · 6.46 KB
/
readme.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
<p align="center">
<img width="300" height="140" alt="Vibranium" src="https://github.com/kelvinkamau/Vibranium/blob/master/src/images/vibranium.png">
</p>
# 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.
[](https://travis-ci.org/kelvinkamau/Vibranium)
[](https://www.codacy.com/app/kamaucodes/Vibranium?utm_source=github.com&utm_medium=referral&utm_content=kelvinkamau/Vibranium&utm_campaign=Badge_Grade)
| Name | Source Code| Demo |
| --- | --- | --- |
| Dark Theme | [GitHub](https://github.com/kelvinkamau/vibranium-dark) | [Preview](https://devclub-kisii.firebaseapp.com) |
|Light Theme | [GitHub](https://github.com/kelvinkamau/Vibranium) | [Preview](https://kelvinkamau.github.io/Vibranium) |
## Creators 👨💻
* [DSC Sub Saharan Africa Leads](https://github.com/DSCLEADSAfrica)
## 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](https://nodejs.org/en/download/) or [yarn](https://yarnpkg.com/en/docs/install)
* 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-tools```or ```yarn global add firebase-tools```
* Create a new firebase project [here](https://console.firebase.google.com/)
* 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
* <s>Mobile site enhancements</s> ✔
* <s>Add tutorials page</s> ✔
* <s>Add projects showcase page</s> ✔
* <s>Progressive Web App support</s> ✔
* Push notifications support 📢
## Updating
Here is a git workflow for updating your fork (or downloaded copy) to the latest version:
```git
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](https://semver.org) for versioning. Current version: v2.0.0
## Websites using Project Vibranium
| Community Name | Location | Web App Link |
| --- | --- | --- |
| DSC Kisii University | Kenya | [Live Here](https://devclub-kisii.firebaseapp.com/) |
| DSC Taita Taveta University | Kenya | [Live Here](https://dsc-at-ttu.firebaseapp.com/) |
| DSC Bayero University Kano | Nigeria | [Live Here](https://dscbuk.club/) |
| DSC Yabatech | Nigeria | [Live Here](https://dscyabatech.firebaseapp.com/) |
| SemaPay | Kenya | [Live Here](https://semapay.co.ke/) |
| DSC University of Nairobi | Kenya | [Live Here](https://dsc-uon.firebaseapp.com) |
| DSC FUTA | Nigeria | [Live Here](https://dscfuta.com) |
| DSC IBBUL | Nigeria | [Live Here](https://dscibbul.club) |
| DSC Purdue University | Indiana, USA | [Live Here](https://dscpurdue.org/) |
| DSC Univesity of Lagos| Nigeria | [Live Here](https://dscunilag.dev/)|
| DSC Ekiti State University | Nigeria | [Live Here](https://dsceksu.herokuapp.com/)|
| DSC Imo State University | Nigeria | [Live Here](https://dscimsu-69385.firebaseapp.com/)|
| DSC Dominion University College, Accra | Ghana | [Live Here](https://dsc-duc.web.app/)|
## 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.
```
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fkelvinkamau%2FVibranium?ref=badge_large)