README.md 1.08 KB
Newer Older
Mark Harding's avatar
Mark Harding committed
1
Minds
Mark Harding's avatar
Mark Harding committed
2 3
==========

Bill Ottman's avatar
Bill Ottman committed
4
___Copyright 2016___
5

6
## Introduction
Bill Ottman's avatar
Bill Ottman committed
7
An open-source, encrypted and reward-based social networking platform. https://minds.com | https://minds.org
8

9 10 11
## Security reports
Please report all security issues to security@minds.com. 

12 13
## License

Bill Ottman's avatar
Bill Ottman committed
14
AGPLv3. Please see the license file of each repository.
15

16 17
Minds is an extension of [Elgg](https://elgg.org).

Mark Harding's avatar
Mark Harding committed
18 19 20 21 22 23 24 25 26 27 28 29 30
## 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
- [Docs](https://github.com/Minds/docs) - Documentation of public and private apis (work in progress)

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

Plugins will eventually be migrated to their own repositories.
31

32
## Setup
33

34 35 36
- `npm install -g gulp`
- `npm install`
- `gulp init`
37

Mark Harding's avatar
Mark Harding committed
38 39 40 41
If that fails then try running:

- `gulp install`

42
## Building
43

44
- `gulp build`
Mark Harding's avatar
Mark Harding committed
45 46 47 48

## Testing

- `gulp test`