From 321eb1b99355de6c307b05d768bb7edfb838c7f4 Mon Sep 17 00:00:00 2001 From: bill bittner Date: Mon, 19 Mar 2018 15:46:49 -0700 Subject: [PATCH] updated readme --- README.md | 14 ++++++++------ server/controllers/publishController.js | 2 +- server/controllers/serveController.js | 2 +- server/helpers/handleShowRender.jsx | 2 +- server/helpers/statsHelpers.js | 2 +- 5 files changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 5321e6c0..0898be0c 100644 --- a/README.md +++ b/README.md @@ -12,11 +12,13 @@ Spee.ch is a web app that reads and publishes images and videos to and from the * start spee.ch * clone this repo * run `npm install` - * create your ` - speechConfig.js` file - * copy `speechConfig.js.example` and name it `speechConfig.js` + * create your own config files in `/config` + * copy `example.js.example` and name it `example.js` * replace the `null` values in the config file with the appropriate values for your environment - * build the app by running `npm run build-prod` + * create your own config files in `/devConfig` + * copy `example.js.example` and name it `example.js` + * note: you must create these files, but the default values are sufficient if you do not want to update them. + * build the app by running `npm run build` * to start the server, run `npm run start` * visit [localhost:3000](http://localhost:3000) * start spee.ch-sync (optional, recommended) @@ -46,8 +48,8 @@ Spee.ch is a web app that reads and publishes images and videos to and from the * /api/claim/publish * example: `curl -F 'name=MyPictureName' -F 'file=@/path/to/myPicture.jpeg' https://spee.ch/api/claim/publish` * Parameters: - * `name` - * `file` (must be type .mp4, .jpeg, .jpg, .gif, or .png) + * `name` (required) + * `file` (required) (must be type .mp4, .jpeg, .jpg, .gif, or .png) * `nsfw` (optional) * `license` (optional) * `title` (optional) diff --git a/server/controllers/publishController.js b/server/controllers/publishController.js index 149293ca..1d133b37 100644 --- a/server/controllers/publishController.js +++ b/server/controllers/publishController.js @@ -1,5 +1,5 @@ const logger = require('winston'); -const db = require('../models/index'); +const db = require('../models'); const lbryApi = require('../helpers/lbryApi.js'); const publishHelpers = require('../helpers/publishHelpers.js'); const { publishing: { primaryClaimAddress, additionalClaimAddresses } } = require('../../config/siteConfig.js'); diff --git a/server/controllers/serveController.js b/server/controllers/serveController.js index 845c465f..a1a8fbc8 100644 --- a/server/controllers/serveController.js +++ b/server/controllers/serveController.js @@ -1,4 +1,4 @@ -const db = require('../models/index'); +const db = require('../models'); const logger = require('winston'); const { returnPaginatedChannelClaims } = require('../helpers/channelPagination.js'); diff --git a/server/helpers/handleShowRender.jsx b/server/helpers/handleShowRender.jsx index aa155e32..e5076c95 100644 --- a/server/helpers/handleShowRender.jsx +++ b/server/helpers/handleShowRender.jsx @@ -1,7 +1,7 @@ import React from 'react'; import { renderToString } from 'react-dom/server'; import { createStore, applyMiddleware } from 'redux'; -import Reducer from 'reducers/index'; +import Reducer from 'reducers'; import { Provider } from 'react-redux'; import { StaticRouter } from 'react-router-dom'; import GAListener from 'components/GAListener'; diff --git a/server/helpers/statsHelpers.js b/server/helpers/statsHelpers.js index 8ec90f22..9e471172 100644 --- a/server/helpers/statsHelpers.js +++ b/server/helpers/statsHelpers.js @@ -1,5 +1,5 @@ const logger = require('winston'); -const db = require('../models/index'); +const db = require('../models'); module.exports = { postToStats (action, url, ipAddress, name, claimId, result) {