33fa048c7e
- Comments-UI is an app so we should pin the dependencies to ensure we know what version it is running |
||
---|---|---|
.. | ||
.github/workflows | ||
cypress | ||
public | ||
scripts | ||
src | ||
.editorconfig | ||
.env | ||
.eslintrc.js | ||
.gitignore | ||
cypress.config.js | ||
LICENSE | ||
package.json | ||
postcss.config.js | ||
README.md | ||
tailwind.config.js | ||
test-results.xml | ||
webpack.config.js | ||
yarn.lock |
Comments Ui
Getting Started with Create React App
This project was bootstrapped with Create React App.
Basic Setup
This section is mostly relevant for core team only for active Comments development.
- Run
yarn start:dev
to start Comments in development mode - Open http://localhost:3000 to view it in the browser.
- To use the local Comments script in a local Ghost site
- Update
config.local.json
in Ghost repo to add "comments" config pointing to local dev server url as instructed on terminal. - By default, this uses port
5368
for loading local Comments script on Ghost site. It's also possible to specify a custom port when running the script using ---port=xxxx
.
- Update
Available Scripts
In the project directory, you can run:
yarn test
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
yarn 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.
yarn 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
yarn build
fails to minify
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
Copyright & License
Copyright (c) 2013-2022 Ghost Foundation - Released under the MIT license.