Further update README #14
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
boutell
approved these changes
Jan 15, 2025
boutell
requested changes
Jan 15, 2025
README.md
Outdated
|
|
||
| * Ensure your variables are correctly uncommented and modified. | ||
| * Check for any caching issues by clearing your browser cache or restarting the build process. | ||
|
|
||
| # Deploying to production | ||
|
|
||
| ## Using Apostrophe hosting | ||
|
|
||
| Apostrophe can provide easy hosting for any ApostropheCMS-Astro monorepo with little or no extra configuration. This can be setup for deployment from Github or other code repository. |
There was a problem hiding this comment.
setup -> set up
So we're holding this back until we release workspaces hosting?
There was a problem hiding this comment.
Fixed and hosting situation updated
boutell
requested changes
Jan 21, 2025
README.md
Outdated
| @@ -23,6 +23,7 @@ To simplify dependency management, this repository includes several root-level s | |||
| - Next, open a terminal instance at the root of each folder (`frontend` and `backend`). Each project needs to be provided with an `APOS_EXTERNAL_FRONT_KEY` environment variable set to the same string value in order to authenticate communication. For example, in each terminal execute `export APOS_EXTERNAL_FRONT_KEY=my-secret-key`. | |||
| - The `astro.config.mjs` file is already set to the normal default values, but if you are running the backend server on a different port, you will also have to set the `APOS_HOST` environment variable. | |||
| - Then, you can start the projects using the accompanying scripts. For example, in a local development environment you can start each with `npm run dev`. | |||
| > Note: Astro is much less stringent about project set-up when running in development mode. It is recommended that you run the `npm run build` followed by the `npm run preview` commands in the `frontend` folder containing the Astro portion of your project to test that it behaves as expected before deployment. We do not recommend starting project using the root `npm run serve-frontend` script during development, this script is used for Apostrophe hosting. | |||
There was a problem hiding this comment.
"starting project" -> "starting the project"
README.md
Outdated
| @@ -231,6 +275,8 @@ Apostrophe hosting will automatically handle: | |||
| - Automatic backups | |||
| - Security updates | |||
|
|
|||
| In the future, we will be providing a path to create your own account and create a new hosted project. In the meantime, you can [contact us](https://apostrophecms.com/contact-us) to get your project set-up. | |||
There was a problem hiding this comment.
your project set-up -> your hosting set up
boutell
requested changes
Jan 22, 2025
README.md
Outdated
| @@ -23,6 +23,7 @@ To simplify dependency management, this repository includes several root-level s | |||
| - Next, open a terminal instance at the root of each folder (`frontend` and `backend`). Each project needs to be provided with an `APOS_EXTERNAL_FRONT_KEY` environment variable set to the same string value in order to authenticate communication. For example, in each terminal execute `export APOS_EXTERNAL_FRONT_KEY=my-secret-key`. | |||
| - The `astro.config.mjs` file is already set to the normal default values, but if you are running the backend server on a different port, you will also have to set the `APOS_HOST` environment variable. | |||
| - Then, you can start the projects using the accompanying scripts. For example, in a local development environment you can start each with `npm run dev`. | |||
| > Note: Astro is much less stringent about project set-up when running in development mode. It is recommended that you run the `npm run build` followed by the `npm run preview` commands in the `frontend` folder containing the Astro portion of your project to test that it behaves as expected before deployment. We do not recommend starting the project using the root `npm run serve-frontend` script during development, this script is used for Apostrophe hosting. | |||
There was a problem hiding this comment.
setup (google agrees this is the noun form)
README.md
Outdated
| @@ -231,6 +275,8 @@ Apostrophe hosting will automatically handle: | |||
| - Automatic backups | |||
| - Security updates | |||
|
|
|||
| In the future, we will be providing a path to create your own account and create a new hosted project. In the meantime, you can [contact us](https://apostrophecms.com/contact-us) to get your hosting set-up. | |||
There was a problem hiding this comment.
"set up" (because it's a verb in this case; the hyphen is not usual)
There was a problem hiding this comment.
Sorry I missed this in the last comment. Fixed.
boutell
approved these changes
Jan 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Summarize the changes briefly, including which issue/ticket this resolves. If it closes an existing Github issue, include "Closes #[issue number]"
While this PR mainly adds the theming section to the existing README, I would like a general readover and feedback on the entire document.
What are the specific steps to test this change?
For example:
What kind of change does this PR introduce?
(Check at least one)
Make sure the PR fulfills these requirements:
If adding a new feature without an already open issue, it's best to open a feature request issue first and wait for approval before working on it.
Other information: