Skip to content

Commit

Permalink
Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
anthonybudd committed Mar 3, 2021
1 parent c8fc2c5 commit e46d5ec
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 28 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License

Copyright (c) 2010-2021 Ideea https://ideea.io
Copyright (c) 2010-2021

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
<p align="center">
<img height="300" src="https://raw.githubusercontent.com/anthonybudd/vipfs/master/docs/img/vipfs-youtube-embed.png" alt="VIPFS">
<img height="300" src="https://raw.githubusercontent.com/anthonybudd/vipfs/master/docs/img/readme-header.png" alt="VIPFS">
</p>

Vue.js + IPFS = VIPFS. VIPFS is an alt-tech framework for creating permanent apps, blogs and websites that cannot be taken offline by anyone, including the government.

# VIPFS
VIPFS is a simple boilerplate project for creating permanent apps, blogs and websites that cannot be taken offline, blocked or censored. The application is built with Vue.js and IPFS, it comes with useful templates and it is pre-integrated with Bootstrap, FontAwesome, Video.js, Vuex and VueRouter. Simply clone, build and run `npm run publish` to deploy it on IPFS and make it permanently accesable to the world.
VIPFS is a simple boilerplate project for creating permanent websites with Vue.js and IPFS, it comes with useful templates and it is pre-integrated with Bootstrap, FontAwesome, Video.js, Vuex and VueRouter. Simply clone, build and run `npm run publish` to deploy it on IPFS and make it permanently accesable to the world.

## Getting Started
```sh
$ git clone git@github.com:Ideea-inc/vipfs.git
$ git clone git@github.com:anthonybudd/vipfs.git
$ cd vipfs
$ npm install
$ npm run build
Expand Down
7 changes: 3 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,13 @@
"description": "VIPFS",
"main": "./src/index.js",
"author": "Anthony C. Budd",
"homepage": "https://ideea.io/vipfs",
"license": "MIT",
"repository": {
"type": "git",
"url": "git+httpshttps://github.com/ideea-inc/vipfs.git"
"url": "git+httpshttps://github.com/anthonybudd/vipfs.git"
},
"bugs": {
"url": "http://github.com/ideea-inc/vipfs/issues"
"url": "http://github.com/anthonybudd/vipfs/issues"
},
"scripts": {
"serve": "node server.js",
Expand Down Expand Up @@ -50,4 +49,4 @@
"sass-loader": "^8.0.2",
"vue-template-compiler": "^2.6.12"
}
}
}
23 changes: 8 additions & 15 deletions src/components/welcome.vue
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
</p>

<p>
<gh-btns-star slug="Ideea-inc/vipfs" />
<gh-btns-watch slug="Ideea-inc/vipfs" />
<gh-btns-fork slug="Ideea-inc/vipfs" />
<gh-btns-star slug="anthonybudd/vipfs" />
<gh-btns-watch slug="anthonybudd/vipfs" />
<gh-btns-fork slug="anthonybudd/vipfs" />
</p>
</div>

Expand All @@ -27,15 +27,7 @@
<footer class="pt-4 my-md-5 pt-md-5 border-top">
<div class="row">
<div class="col-12 col-md">
<a href="https://ideea.io">
<img
class="mb-2"
src="https://ideea.io/static/img/icon-small.png"
alt="Ideea Logo"
width="30"
>
</a>
<small class="d-block mb-3 text-muted">© Ideea 2021</small>
<small class="d-block mb-3 text-muted">© Anthony C. Budd 2021</small>
</div>

<div class="col-6 col-md">
Expand Down Expand Up @@ -73,11 +65,11 @@
<ul class="list-unstyled text-small">
<li><a
class="text-muted"
href="https://github.com/Ideea-inc/vipfs"
href="https://github.com/anthonybudd/vipfs"
>GitHub</a></li>
<li><a
class="text-muted"
href="https://ideea.io/vipfs/getting-started-tutorial"
href="https://github.com/anthonybudd/vipfs/tree/master/docs/tutorial.md"
>Tutorial</a></li>
<li><a
class="text-muted"
Expand All @@ -100,7 +92,8 @@
<li><a
class="text-muted"
href="https://ideea.io"
>Ideea</a></li>
>Ideea</a>
</li>
</ul>
</div>
</div>
Expand Down
8 changes: 5 additions & 3 deletions src/index.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<!DOCTYPE html>
<html lang="en">

<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
Expand All @@ -15,9 +16,9 @@ <h5 class="my-0 mr-md-auto font-weight-normal" @click="$router.push(`/`)">
<img src="storage/images/vipfs-logo.svg" alt="VIPFS Logo" width="100">
</h5>
<nav class="my-2 my-md-0 mr-md-3">
<a class="p-2 text-dark" href="https://github.com/Ideea-inc/vipfs">GitHub</a>
<a class="p-2 text-dark" href="https://ideea.io/vipfs/getting-started-tutorial">Tutorial</a>
<a class="p-2 text-dark" href="https://github.com/Ideea-inc/vipfs/tree/master/docs">Docs</a>
<a class="p-2 text-dark" href="https://github.com/anthonybudd/vipfs">GitHub</a>
<a class="p-2 text-dark" href="https://github.com/anthonybudd/vipfs/tree/master/docs/tutorial.md">Tutorial</a>
<a class="p-2 text-dark" href="https://github.com/anthonybudd/vipfs/tree/master/docs">Docs</a>
</nav>
<button class="btn btn-outline-primary" @click="onClickDonate">Donate</button>
</div>
Expand All @@ -31,4 +32,5 @@ <h5 class="my-0 mr-md-auto font-weight-normal" @click="$router.push(`/`)">

<script src="app.js" lang="text/javascript"></script>
</body>

</html>
4 changes: 2 additions & 2 deletions src/store.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ const mutations = {
}

const actions = {
getGitHubStars ({ commit }) {
getGitHubStars({ commit }) {
return new Promise((resolve, reject) => {
axios.get('https://api.github.com/repos/Ideea-inc/vipfs')
axios.get('https://api.github.com/repos/anthonybudd/vipfs')
.then(({ data }) => {
commit('setGitHubStars', data.stargazers_count)
resolve(data.stargazers_count)
Expand Down

0 comments on commit e46d5ec

Please sign in to comment.