Skip to content

Commit

Permalink
Update main repo readme (#429)
Browse files Browse the repository at this point in the history
* fix: update contributing guide link and correct playground config file extension

* docs: update README with additional setup instructions for environment variables

* add note about example file for environment variables
  • Loading branch information
Adammatthiesen authored Feb 27, 2025
1 parent fec63cf commit f17c816
Showing 1 changed file with 7 additions and 15 deletions.
22 changes: 7 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ If you encounter any bugs or have ideas for new features, please open an issue o

### Code Contributions

We welcome contributions from the community! Whether it's bug reports, feature requests, or code contributions, we appreciate your help in making this project better. To get started read our [Contributing Guide](https://docs.studiocms.xyz/contributing/getting-started/)
We welcome contributions from the community! Whether it's bug reports, feature requests, or code contributions, we appreciate your help in making this project better. To get started read our [Contributing Guide](https://docs.studiocms.dev/contributing/getting-started/)

Please note that by contributing to this project, you agree to our [Code of Conduct](https://github.com/withstudiocms/.github/blob/main/CODE_OF_CONDUCT.md).

Expand All @@ -45,28 +45,20 @@ For an up-to-date list of our main tools check out our [`.prototools`](.prototoo

For more information about Proto checkout [Proto's Website](https://moonrepo.dev/proto)

## This is a [`Moon repository`](https://moonrepo.dev)

Follow install instructions listed on Moonrepo's docs, and you'll be all set to go! Its even a super easy single line command you put in your terminal!

To use the dev server the command is `moon run playground:dev`

> Note: You can always fallback to standard pnpm, Please ensure your version matches our project, and run `pnpm i --frozen-lockfile` to install deps
## How to use the playgrounds

At the moment these are the current steps for setting up the main StudioCMS playground.

This is intended for testing and development, since we have not yet released a package to play with use these instruction _at your own risk_ This project is still very experimental

The primary playground is the [Node Playground](./playgrounds/node/)
The primary playground is the [Node Playground](./playground/)

Steps to get a running playground should be the following:

- clone repo
- run `pnpm i --frozen-lockfile`
- change `dbStartPage` in the [node playground's](./playground/studiocms.config.mts) config to `true`
- read the first time setup instructions listed in the [main package readme](./packages/studiocms/README.md#first-start-and-setup) then replace the astro db commands with the following:
- Clone the GitHub repository
- Run `pnpm i --frozen-lockfile`
- Change `dbStartPage` in the [node playground's](./playground/studiocms.config.mjs) config to `true`
- Ensure `.env` variables are configured (see [`.env.demo`](./playground/.env.demo) for an example of available environment variables)

Commands to run:

Expand All @@ -77,7 +69,7 @@ Once that process completes successfully you are ready to navigate to http://loc

It will redirect and ask you to shutdown and change the above mentioned config option `dbStartPage` to `false` at which point that will enable full functionality of the CMS. you can now restart the dev server with `astro dev --remote` to continue viewing your new site!

That will give you a running dev environment of what we work with daily... the only other thing to get the full functionality currently is to configure a gitub oAuth app for the [Dashboard and authentication](./packages/studiocms/README.md#authentication)
That will give you a running dev environment of what we work with daily.

To start the playground again use the command `pnpm playground:dev`

Expand Down

0 comments on commit f17c816

Please sign in to comment.