https://github.com/zurfyx/usocial
The uPort Social Module
https://github.com/zurfyx/usocial
Last synced: 7 days ago
JSON representation
The uPort Social Module
- Host: GitHub
- URL: https://github.com/zurfyx/usocial
- Owner: zurfyx
- License: mit
- Created: 2019-01-02T11:23:24.000Z (over 6 years ago)
- Default Branch: development
- Last Pushed: 2019-03-07T19:26:48.000Z (about 6 years ago)
- Last Synced: 2025-04-26T12:05:59.360Z (23 days ago)
- Language: JavaScript
- Homepage: https://uport-social.herokuapp.com
- Size: 951 KB
- Stars: 4
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# uSocial
> The uPort Social Module
[](https://travis-ci.org/zurfyx/usocial)
[Master] https://uport-social.herokuapp.com
[](https://travis-ci.org/zurfyx/usocial)
[Development] https://uport-social-dev.herokuapp.com
- [uSocial Tools](https://github.com/zurfyx/usocial/tree/development/packages/usocial)
## Getting started
```
npm install
npm start
```
## Production
```
export NODE_ENV=production
export PORT=3000
export API_PORT=3001
export REACT_APP_CLIENT=http://localhost:3000
export REACT_APP_API=http://localhost:3001
npm run build
npm run serve
```
## Environment variables
- NODE_ENV: `production` or `development`
- REACT_APP_CLIENT: Client base URL (i.e. `http://localhost:3000`)
- REACT_APP_API: API base URL (i.e. `http://localhost:3001`). When not set, the client will default
to `http://localhost:3001` and API will automatically initialize a new ngrok instance on boot to
handle uPort callbacks.
- PORT: Client port to listen to (i.e. `3000`). For the client, PORT > 3000
- API_PORT: API port to listen to (i.e. `3001`. For the API, API_PORT > PORT > 3001
- UPORT_PRIVATE_KEY: uPort signing key. Can be generated through
`const { did, privateKey } = Credentials.createIdentity()` or
[uPort My Appps](https://developer.uport.me/myapps)
Client is only aware of environment variables starting with `REACT_APP_`.
Environment variables can also be set through `.env` files, see `.env.example` in `packages//`.
## Thanks
- [Attester](https://github.com/rhizomik/attester)
## License
MIT © Gerard Rovira Sánchez