Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add instructions to README, and update link on Get Started page #129

Closed
wants to merge 1 commit into from
Closed

Add instructions to README, and update link on Get Started page #129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,21 @@ All commands are run from the root of the project, from a terminal:
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `npm run astro --help` | Get help using the Astro CLI |

## Instructions on how to run your own server
The archive file contains a dist/ folder that needs to be placed into a copy of this cloned repo. Then you can serve it using grunt serve. On a production site, you should to use these environment variables:
Copy link
Member

@taoeffect taoeffect Jul 21, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahh, I see... what happened, sorry for not being clear in the issue - but this section should be added to the README in the group-income repo, not the groupincome.org repo. Can you send in a PR there?

For this PR we just need the change below to link to the group-income repo.

(Also, can you add an empty line after the heading too?)


```
NODE_ENV=production
GI_PERSIST=sqlite (or GI_PERSIST=fs, but sqlite is recommended)
```

We plan to eventually publish some docker containers that will do all of this for you.


## 👀 Want to learn more?

Check out [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).

## Credit

This theme is based off of the lovely [Bear Blog](https://github.com/HermanMartinus/bearblog/).
This theme is based off of the lovely [Bear Blog](https://github.com/HermanMartinus/bearblog/).
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No changes, Git marks as a change - not relevant.

2 changes: 1 addition & 1 deletion src/pages/get-started.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import Servers from '../components/Servers.vue';
<Servers />
<p class="c-container-para">
Don’t see a server you like?
<a href="https://github.com/okTurtles/group-income" class="link server-link" target="_blank">
<a href="https://github.com/okTurtles/groupincome.org#-instructions-on-how-to-run-your-own-server" class="link server-link" target="_blank">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please update this to point to the group-income repo's README, and double-check that the hash is correct as I'd be surprised if it started with a -...

Run your own server
</a>
</p>
Expand Down