An open API service indexing awesome lists of open source software.

https://github.com/frenchbread/sn-server


https://github.com/frenchbread/sn-server

Last synced: about 1 year ago
JSON representation

Awesome Lists containing this project

README

          

# Social Notifier Server

> API server for [sn-app](https://github.com/frenchbread/sn-app)

## Configuration file & API keys

Place configuration to `src/config/index.js` that looks like this:

```js
export default {
port: 8000,
env: 'development',
auth: {
secret: ''
},
database: {
local: 'mongodb://localhost/sn',
prod: ''
},
telegram: {
url: 'https://api.telegram.org/bot',
socials: {
twitter_token: '',
instagram_token: '',
vk_token: '',
youtube_token: ''
}
},
twitter: {
consumer_key: '',
consumer_secret: '',
access_token_key: '',
access_token_secret: ''
},
vk: {
appId: 123123,
appSecret: '',
userLogin: '',
userPassword: ''
}
}
```

## Setup

> **Note:** SN-server requires MongoDB instance up and running.

```bash
# Install dependencies
$ yarn install

# Run in development
$ yarn run dev

# Build & Run for production
$ yarn run build
$ yarn run start
```

## TODO

- [ ] Add guide explaining how to obtain API keys for social services.

## LICENSE
[MIT](https://github.com/frenchbread/sn-server/blob/master/LICENSE.md)