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

https://github.com/devenes/twitcher

A Messenger App built in React and Node.js using getStream.io. This project is a clone of an online stream platform. The purpose of this project is to provide a quick and easy way to get started with streaming and chat applications.
https://github.com/devenes/twitcher

backend frontend getstream nodejs npm react reactjs

Last synced: about 2 months ago
JSON representation

A Messenger App built in React and Node.js using getStream.io. This project is a clone of an online stream platform. The purpose of this project is to provide a quick and easy way to get started with streaming and chat applications.

Awesome Lists containing this project

README

          

# Getting Started with Twitcher

A Messenger App built in React and Node.js using getStream.io. This project is a clone of an online stream platform. The purpose of this project is to provide a quick and easy way to get started with streaming and chat applications. The project was built using the educational content created by Ania Kubow.

## Getting Started with Create React App

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

## Definining Credentials

Define your [Get Stream](https://getstream.io/) credentials in `.env` file:

```
API_KEY={your_key}
API_SECRET={your_secret}
APP_ID={your_id}
```

## Available Scripts

In the project directory, you can run:

### `npm i`

Install all the packages you need by running the command in your terminal. This will install all the dependencies listed in `package.json`.

### `npm run start:frontend`

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.

### `npm run start:backend`

This will start the server on [http://localhost:8000](http://localhost:8000).

The page will reload if you make edits.\
You will also see any lint errors in the console.

### `npm test`

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `npm run build`

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

### `npm run eject`

**Note: this is a one-way operation. Once you `eject`, you can't go back!**

If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

## Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).

### Code Splitting

This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)

### Analyzing the Bundle Size

This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)

### Making a Progressive Web App

This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)

### Advanced Configuration

This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)

### Deployment

This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)

### `npm run build` fails to minify

This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)

### Resources

[Chat App with Authentication](https://youtu.be/xyiuBEBv0_0)

[Chat Messaging Docs](https://getstream.io/chat/docs/)

[React Chat SDK Messaging Components](https://getstream.io/chat/sdk/react/)