Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jzongker authored Dec 2, 2024
1 parent 1ca4873 commit 1627961
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,27 @@

An import/export/conversion tool for Chums

### Dev Setup Instructions
## Get Involved

For the APIs, you may either set them up on your local machine first, or point to the staging server copies during development. The staging server urls are in the sample dotenv files.
### 🤝 Help Support Us

The only reason this program is free is because of the generous support from users. If you want to support us to keep this free, please head over to [ChurchApps](https://churchapps/partner) or [sponsor us on GitHub](https://github.com/sponsors/ChurchApps/). Thank you so much!

### 🏘️ Join the Community

We have a great community for end-users on [Facebook](https://www.facebook.com/churchapps.org). It's a good way to ask questions, get tips and follow new updates. Come join us!

### ⚠️ Report an Issue

#### ChumsTranser
If you discover an issue or have a feature request, simply submit it to our [issues log](https://github.com/ChurchApps/ChurchAppsSupport/issues). Don't be shy, that's how the program gets better.

### 💬 Join us on Slack

If you would like to contribute in any way, head over to our [Slack Channel](https://join.slack.com/t/livechurchsolutions/shared_invite/zt-i88etpo5-ZZhYsQwQLVclW12DKtVflg) and introduce yourself. We'd love to hear from you.

### 🏗️ Start Coding

For the APIs, you may either set them up on your local machine first, or point to the staging server copies during development. The staging server urls are in the sample dotenv files.

1. Copy `dotenv.sample.txt` to `.env` and updated it to point to the appropriate API urls.
2. Install the dependencies with: `npm install`
Expand Down

0 comments on commit 1627961

Please sign in to comment.