remotv / remo-web-client

9 stars 8 forks source link

Remo Web Client

This is the frontend web client for Remo.TV built in React.

Setup:

Make sure you have npm installed, then run the following:

npm install

IMPORTANT! Disable tracking for overrides.js, never ever commit any changes to the overrides.js file.
If your IDE is tracking changes to overrides.js, run this command:

git update-index --skip-worktree src/config/overrides.js

Instructions for running the client stand-alone TBD, for now you must also run the platform server as
localhost:3000 via https://github.com/remotv/remo-platform-server

Then in termal run:

npm run react

Application Structure:

For future development, componets will be migrated into these folders within the components folder:
functional - Pure logic and function components
presentation - Pure Style & CSS application
routing - Interal application navigation & routing structure
content - Pure Content, example: TOS text containers ( maybe ) - Basically components that just contain other components, like "NavBar".
providers - Context Providers
stores - application data stores

Any additional folders are part of an older structure, and will eventually be migrated into this new structure.

Available Scripts:

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser. This command will also boot the websocket server, currently running on port: 3231

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 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 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.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: 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

Making a Progressive Web App

This section has moved here: 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

Deployment

This section has moved here: 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