Adds a very simple INSTALL file for devs.

This commit is contained in:
gaba
2016-12-21 13:17:04 -08:00
parent 917feeaba2
commit 7f86c936ad
+85
View File
@@ -0,0 +1,85 @@
# BUILDING FROM SOURCE
By contributing to this project you agree to the [Code of Conduct](https://coralproject.net/code-of-conduct.html).
## Requirements
* [Node 7.2.1](https://nodejs.org/es/download/package-manager)
* Mongo 3.4.0
* Redis 3.2.6
### Operating System
- We recommend hosting [Talk](https://github.com/coralproject/talk) with any flavor of Linux
- 1GB memory (minimum)
- 5GB storage (minimum)
## Initial Setup
### Get the code
Clone the repository:
`
git clone https://github.com/coralproject/talk
`
### Installation
* cd talk
* npm install
* npm run build
### Environmental Variables
export TALK_PORT=5000
export TALK_MONGO_URL=mongodb://localhost/talk
export TALK_REDIS_URL=redis://redis/talk
export TALK_SESSION_SECRET=somethingsecret
export TALK_FACEBOOK_APP_ID=fbidapp_youneeditforfbconnect
export TALK_FACEBOOK_APP_SECRET=fbappsecret_youneeditforfbconnect
export TALK_ROOT_URL=http://localhost:5000
export TALK_SMTP_USERNAME=coralproject
export TALK_SMTP_PASSWORD=smtppassword
export TALK_SMTP_HOST=smtp.example.net
export TALK_SMTP_PROVIDER=Example
### Local development
`
npm start
`
It will run in http://localhost:5000
### Testing
Run all tests once via:
`
npm test
`
`
npm run e2e
`
## Recommendations for Deployment
##### Web Server
* [Caddy](https://caddyserver.com/)
##### SSL Certificates
* [Let's Encrypt](https://letsencrypt.org/)
## Troubleshooting
##### Can't ping the redis server!
- Check that Redis Server is running.
- Check that TALK_REDIS_URL is set.