mirror of
https://github.com/wassname/talk.git
synced 2026-07-15 11:26:58 +08:00
Updated documentation
This commit is contained in:
+6
-6
@@ -27,7 +27,7 @@ Navigate to a directory.
|
||||
```
|
||||
git clone https://github.com/coralproject/talk
|
||||
cd talk
|
||||
npm install
|
||||
yarn install
|
||||
```
|
||||
|
||||
### Environmental Variables
|
||||
@@ -42,7 +42,7 @@ Talk uses environmental variables for configuration. You can learn about them in
|
||||
Starting the server:
|
||||
|
||||
```
|
||||
npm start
|
||||
yarn start
|
||||
```
|
||||
|
||||
Browse to `http://localhost:3000` (or your custom port.)
|
||||
@@ -54,13 +54,13 @@ Our build process will build all front end components registered [here](https://
|
||||
One time build:
|
||||
|
||||
```
|
||||
npm build
|
||||
yarn build
|
||||
```
|
||||
|
||||
Build, then rebuild when a file is updated (development build):
|
||||
|
||||
```
|
||||
npm build-watch
|
||||
yarn build-watch
|
||||
```
|
||||
|
||||
|
||||
@@ -69,13 +69,13 @@ npm build-watch
|
||||
Run all tests once:
|
||||
|
||||
`
|
||||
npm test
|
||||
yarn test
|
||||
`
|
||||
|
||||
Run our end to end tests (will install Selenium and nightwatch):
|
||||
|
||||
`
|
||||
npm run e2e
|
||||
yarn e2e
|
||||
`
|
||||
|
||||
_Please ensure all tests are passing before submitting a PR!_
|
||||
|
||||
@@ -5,19 +5,19 @@ This app handles moderation for Talk (and maybe more later on)
|
||||
|
||||
## Installation
|
||||
|
||||
$ npm install
|
||||
$ yarn install
|
||||
$ cp config.sample.json config.json
|
||||
|
||||
Then change `config.json` to adjust it to your project
|
||||
|
||||
## Building for production
|
||||
|
||||
$ npm run build
|
||||
$ yarn build
|
||||
|
||||
The public folder has everything you need for deployment. You can just copy that folder to your favorite static web server
|
||||
|
||||
## Development
|
||||
|
||||
$ npm start
|
||||
$ yarn start
|
||||
|
||||
A development server will be running at http://localhost:4132
|
||||
|
||||
@@ -112,7 +112,7 @@ http://eslint.org/docs/rules/#best-practices
|
||||
|
||||
## Lint the code
|
||||
```js
|
||||
npm run lint
|
||||
yarn lint
|
||||
```
|
||||
|
||||
|
||||
|
||||
@@ -71,10 +71,10 @@ The `pree2e` script will create 3 users: a Commenter, a Moderator, and an Admin
|
||||
|
||||
## Run the tests
|
||||
Run Talk
|
||||
`dotenv npm run start`
|
||||
`dotenv yarn start`
|
||||
|
||||
Run e2e tests
|
||||
`npm run e2e`
|
||||
`yarn e2e`
|
||||
|
||||
|
||||
## Advanced Nightwatch and Selenium Settings
|
||||
|
||||
Reference in New Issue
Block a user