Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(docs): Updated README.md to reflect documentation updates #67

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 25 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,65 +1,45 @@
Minds
==========

## Introduction
An open-source, encrypted and reward-based social networking platform. https://minds.com | https://minds.org

## Security reports
Please report all security issues to [email protected].

## License

AGPLv3. Please see the license file of each repository.
=====
Minds is an open-source, encrypted and reward-based social networking platform. https://minds.com

## Repositories

Minds is split into multiple components:

- [Engine](https://github.com/Minds/engine) - Backend code & APIs
- [Front](https://github.com/Minds/front) - Client side Angular2 web app
- [Sockets](https://github.com/Minds/sockets) - WebSocket server for real-time communication (WIP)
- [Docs](https://github.com/Minds/docs) - Documentation of public and private apis (WIP)
- Sockets (Coming Soon) - WebSocket server for real-time communication

Please also see:
- [Mobile](https://github.com/Minds/mobile) - WebSocket server for real-time communication
- [Mobile](https://github.com/Minds/mobile)

Plugins will eventually be migrated to their own repositories.

## Download and Provisioning

- Git
- Vagrant

Clone this repository and run `init.sh` (or `init.bat` if you're on Windows) to clone submodules. Run
`vagrant up` to create, provision and run the VM.
## Documentation
Documentation for Minds can be found at [minds.org/docs](https://www.minds.org/docs)
1. [Installation](https://www.minds.org/docs/install.html)
1. [Requirements](https://www.minds.org/docs/install/requirements.html)
2. [Download](https://www.minds.org/docs/install/download.html)
3. [Vagrant Development Environment](https://www.minds.org/docs/install/vagrant.html)
4. [Install & Build](https://www.minds.org/docs/install/preparation.html)
1. [Front End](https://www.minds.org/docs/install/preparation.html#front-end)
2. [Engine](https://www.minds.org/docs/install/preparation.html#engine-php)
3. [Install Script](https://www.minds.org/docs/install/installation.html)
5. [Troubleshooting](https://www.minds.org/docs/install/troubleshooting.html)
2. [Testing](https://www.minds.org/docs/testing.html)
3. [Contributing](https://www.minds.org/docs/contributing.html)

## Contributing
If you'd like to contribute to the Minds project, check out the [Contribution](https://www.minds.org/docs/contributing.html) section of Minds.org or head right over to the [Minds Open Source Community](https://www.minds.com/groups/profile/365903183068794880). If you've found or fixed a bug, let us know in the [Minds Help and Support Group](https://www.minds.com/groups/profile/100000000000000681/activity)!

## Installing and Building Developer version

- NodeJS >= 4
- NPM >= 3
- Grunt CLI

On `front` directory:
- `npm install`
- `gulp build`
- `gulp build.index`

## Building Prodution version
- NodeJS >= 4
- NPM >= 3

On `front` directory:
- `npm install`
- `npm run build`

## Testing
## Security reports
Please report all security issues to [[email protected]](mailto:[email protected]).

- `gulp test`
## License
[AGPLv3](https://www.minds.org/docs/license.html). Please see the license file of each repository.

## Credits

[PHP](https://php.net), [Cassandra](http://cassandra.apache.org/), [Angular2](http://angular.io), [Nginx](https://nginx.com), [Ubuntu](https://ubuntu.com), [OpenSSL](https://www.openssl.org/), [RabbitMQ](https://www.rabbitmq.com/), [Elasticsearch](https://www.elastic.co/), [Cordova](https://cordova.apache.org/), [Neo4j](https://neo4j.com/), [Elgg](http://elgg.org), [Node.js](https://nodejs.org/en/), [MongoDB](https://www.mongodb.com/), [Redis](http://redis.io/), [WebRTC](https://webrtc.org/), [Socket.io](http://socket.io/), [TinyMCE](https://www.tinymce.com/), [Ionic](http://ionicframework.com/), [Requirejs](http://requirejs.org/), [OAuth](http://oauth.net/2/), [Apigen](http://www.apigen.org/), [Braintree](https://www.braintreepayments.com/). If any are missing please feel free to add.

___Copyright Minds 2012 - 2016___
___Copyright Minds 2012 - 2017___

Copyright for portions of Minds are held by [Elgg](http://elgg.org), 2013 as part of the [Elgg](http://elgg.org) project. All other copyright for Minds is held by Minds, Inc.