Ghost/apps/comments-ui
Daniel Lockyer 33fa048c7e Pinned dependencies
- Comments-UI is an app so we should pin the dependencies to ensure we
  know what version it is running
2023-03-21 09:59:12 +01:00
..
.github/workflows Added custom build setup 2022-07-04 15:15:01 +02:00
cypress Updated counts api url (#12) 2022-11-02 10:02:26 +04:00
public This seems to fix the modal zooming on iOS 2022-08-11 09:16:55 +01:00
scripts Setup app to support prod published flow 2022-07-08 13:09:02 +02:00
src Fixed minor linting issues 2023-03-17 12:19:52 +01:00
.editorconfig Initial commit 2022-07-04 14:54:12 +02:00
.env Added custom build setup 2022-07-04 15:15:01 +02:00
.eslintrc.js Added experimental Cypress tests 2022-09-09 17:27:32 +02:00
.gitignore Added experimental Cypress tests 2022-09-09 17:27:32 +02:00
cypress.config.js Added experimental Cypress tests 2022-09-09 17:27:32 +02:00
LICENSE Initial commit 2022-07-04 14:54:12 +02:00
package.json Pinned dependencies 2023-03-21 09:59:12 +01:00
postcss.config.js Added Tailwind CSS 2022-07-05 10:15:12 +02:00
README.md Updated counts api url (#12) 2022-11-02 10:02:26 +04:00
tailwind.config.js Removed the duplicate sm config 2022-11-11 15:25:57 +00:00
test-results.xml Added experimental Cypress tests 2022-09-09 17:27:32 +02:00
webpack.config.js Added custom build setup 2022-07-04 15:15:01 +02:00
yarn.lock Pinned dependencies 2023-03-21 09:59:12 +01:00

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.

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.