1
0
mirror of https://github.com/fazo96/ipfs-boards synced 2025-01-10 12:24:20 +01:00
a truly distributed social platform for the browser with no backend and no external applications required
Go to file
2015-11-20 16:06:00 +01:00
lib sort posts by date and fix submitter display 2015-11-19 16:51:04 +01:00
webapp added extra check for error 2015-11-20 16:06:00 +01:00
.eslintrc added more linting, error checking, better build system 2015-11-14 10:46:42 +01:00
.gitignore added gulp task to publish to ghpages 2015-11-19 18:06:45 +01:00
cli.js restructuring cli 2015-11-16 14:35:00 +01:00
FAQ.md updated docs 2015-11-14 00:16:45 +01:00
gulpfile.js added gulp task to publish to ghpages 2015-11-19 18:06:45 +01:00
HACKING.md added dev env. information 2015-11-15 21:34:22 +01:00
ipfs_daemon_set_cors.sh updated cors istructions 2015-11-18 17:03:52 +01:00
LICENSE add license 2015-11-15 22:25:06 +01:00
package.json update ipfs api 2015-11-20 12:42:01 +01:00
PROTOCOL.md added note about 'op' field in posts 2015-11-19 17:38:18 +01:00
publish_profile.sh added script to publish a profile folder 2015-11-19 12:57:38 +01:00
README.md updated demo url 2015-11-19 12:57:50 +01:00
upload_webapp_on_ipfs.sh added script to upload app to ipfs 2015-11-19 12:21:16 +01:00

IPFS Boards

Image and discussion boards, forums and the like have many problems:

  • Centralized

    • What if it gets shut down?
    • What if the servers are down?
    • What if a phisical network link breaks and the data is on the other side?
    • What if the owners of the board get eaten by aliens?
  • Fragile

    • what if there's a DoS attack?
    • what if there is a usage explosion and the servers can't handle it?
    • what if the datacenter is flooded and data is lost?
  • Closed Down, limited in possibilities

    • What if I want to write a custom client and there is no API?
    • What if I want to change the user interface?
    • What if I want to use it in a LAN with no Internet access?
    • What if I want a name that someone else already has?
    • What if I want to move my data to another service/subreddit/forum ?
    • What if I want more control (think a private forum), or less control (think 4chan) ?
    • What if I want ?

This project was conceived to solve that. With the help of modern web technologies, the IPFS and IPNS protocols and some optional cache servers, we can solve these problems and create a true universal platform which can act as:

  • Discussion board, like reddit or 4chan
  • Blog with dynamic comments
  • Wiki
  • File Sharing platform
  • (Maybe) Forum (not sure because it would require some changes, but maybe)
  • (Maybe) E-Learning platform

With security, control, reliability, rock solid stability, fully distributed architecture or, optionally, none of these!

FAQ

See FAQ.md

How does it work?

See PROTOCOL.md

Demo / Prototype

You can find a working build here.

You need a local instance of go-ipfs running for it to work. You also need to set CORS settings right or it won't work. However, in that case, it will complain to you and provide instructions.

Keep in mind that it's a very early prototype, nothing is finished, nothing is polished, but something works. It's also probably full of security holes, very inefficient, slow, etc. You're welcome to help in any way though!

Also, remember that it doesn't have:

  • Ability to post and create a profile from the web app (it's read only for now)
  • Aggregation (only the admin can post, for now)
  • Advanced customization, control, user profile customization
  • Media support
  • Votes
  • Comments
  • Actually nice user interface
  • Ability to run without a full IPFS node. That would require either a backend or the (currently not done) js implementation of IPFS

Ability to publish stuff in the browser won't be implemented until go-ipfs 0.4 is ready. It will maybe be ready before the new year. You will be able to publish your boards/profile/posts using a CLI though.

How do I set up a development environment?

See HACKING.md

Components

  • Client
    • a static web application to access IPFS Boards
    • maybe a desktop version (which would be a wrapped web application)
    • will be able to do everything in a simple browser
  • Server
    • Completely Optional (not right now, but it will be)
    • can cache content so that it doesn't get lost
    • fully configurable
    • can serve the Client
    • can render the client application so that search engines can index content
    • can provide content over an HTTP API or web sockets so that devices can save bandwidth

Note: until the IPFS Javascript Implementation is done:

  • the client (a static web application) requires a full IPFS node because it needs to be able to discover content via the IPFS API.
  • the cache server (written in node) requires a full IPFS node.

Note: if you want to write data, your IPNS needs to be taken over by the application. This problem will be solved after go-ipfs 0.4 with the files API is released.

License

IPFS Boards
Copyright (C) 2015 Enrico Fasoli

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.