The Crypto Social Network
Switch branches/tags
Nothing to show
Clone or download

README.md

Minds

Minds is an open-source, encrypted and reward-based social networking platform. https://minds.com

Repositories

Minds is split into multiple repositories:

  • Engine - Backend code & APIs
  • Front - Client side Angular2 web app
  • Sockets - WebSocket server for real-time communication
  • Mobile - React Native mobile apps

Development System Requirements

Development Installation

  1. Run sh init.sh in order to install the front and engine repositories
  2. Run docker-compose up -d nginx
  3. Run docker-compose up installer (one time only.. initial username: minds / password: Pa$$w0rd)
  4. Run docker-compose up front-build
  5. Navigate to http://localhost:8080

Troubleshooting

  • Minds is already installed

    • Ensure engine/settings.php does not exist and re-run docker-compose up installer
  • Cassandra will not boot

    • Ensure thrift is enabled
    • Cassandra requires at least 4GB of memory to operate. You can start Cassandra manually by running docker-compose up cassandra

Production System Requirements

At this time it is not advisable to run Minds in production, however it is possible so long as you are aware of the risks.

  • 3 Cassandra Nodes (Min 30gb RAM, 1TB SSD, 8 CPU)
  • 1 ElasticSearch Node (Min 16GB RAM, 250GB SSD, 8 CPU) #2 nodes are recommended for failover
  • 1 Docker Machine (Min 60gb RAM, 50GB SSD, 32 CPU)

Contributing

If you'd like to contribute to the Minds project, check out the Contribution section of Minds.org or head right over to the Minds Open Source Community. If you've found or fixed a bug, let us know in the Minds Help and Support Group!

Security reports

Please report all security issues to security@minds.com.

License

AGPLv3. Please see the license file of each repository.

Credits

PHP, Cassandra, Angular2, Nginx, Ubuntu, OpenSSL, RabbitMQ, Elasticsearch, Cordova, Neo4j, Elgg, Node.js, MongoDB, Redis, WebRTC, Socket.io, TinyMCE, Ionic, Requirejs, OAuth, Apigen, Braintree. If any are missing please feel free to add.

Copyright Minds 2012 - 2018

Copyright for portions of Minds are held by Elgg, 2013 as part of the Elgg project. All other copyright for Minds is held by Minds, Inc.