Skip to content

Commit

Permalink
Updating README
Browse files Browse the repository at this point in the history
  • Loading branch information
craigstroman committed Oct 28, 2020
1 parent c6638b6 commit 21a3bff
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,23 @@
## Slack Clone Client

Based on the tutorial from https://awesomereact.com/playlists/slack-clone-using-graphql/0MKJ7JbVnFc.

Online demo at http://slack-clone.craigstroman.com/.

## Running locally

- Clone the repo at https://github.com/craigstroman/slack-clone-client.git.
- CD into slack-clone-client.
- Run `npm install` to install all required Node moduels.
- Run `npm run start` to start the client development environment.
- You can visit http://localhost:3000 in the browser to view it. But to do anything you need the
[Slack Clone Server](https://github.com/craigstroman/slack-clone-server) running in another terminal window locally.

Note: This is running on WebPack devServer and will automatically refresh when you make changes to the project.

## Running in production

- CD into slack-clone-server.
- Run `npm run prod`.
- This will create a production build file of the JavaScript within /public/js/main.min.js.
- Upload the main.min.js to the /public directory within your production build of the server. For that I'm using [Pug](https://pugjs.org/api/getting-started.html) with [Express](https://expressjs.com/).

0 comments on commit 21a3bff

Please sign in to comment.