Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jzongker authored May 27, 2024
1 parent 9330fbd commit f5d93e6
Showing 1 changed file with 23 additions and 13 deletions.
36 changes: 23 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,36 @@
# CHUMS
<img align="right" width="150" src="https://raw.githubusercontent.com/ChurchApps/ChumsApp/main/public/images/logo.png">

**CHU**rch **M**anagement **S**oftware
# CHUMS

Visit <a href="https://chums.org/">https://chums.org/</a> to learn more.
> **CHUMS** is completely free, open-source **CHU**rch **M**anagement **S**oftware that allows you to manage key data on church members and visitors. It offers comprehensive features including member and guest information tracking, attendance management with a self check-in app, group coordination, donation tracking with detailed reports, and custom form creation. Visit <a href="https://chums.org/">https://chums.org/</a> to learn more.
## Contributing
## Preview

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
<div style="display: flex;gap: 10px;">
<img style="width: 49%;" src="https://github.com/ChurchApps/ChumsApp/assets/1447203/ccb5dc7b-8c0d-4320-abac-a3128c42beff">
<img style="width: 49%;" src="https://github.com/ChurchApps/ChumsApp/assets/1447203/ac8593f1-0ae7-45aa-972e-82eaaf0dd639">
</div>
<div style="display: flex;gap: 10px;margin-top: 10px;">
<img style="width: 49%;" src="https://github.com/ChurchApps/ChumsApp/assets/1447203/20f41345-da7d-460a-a64f-224b612ad976">
<img style="width: 49%;" src="https://github.com/ChurchApps/ChumsApp/assets/1447203/ab7c109b-e4e4-4ac5-8b10-fa8cd633ccfd">
</div>

#### Join us on [Slack](https://join.slack.com/t/livechurchsolutions/shared_invite/zt-i88etpo5-ZZhYsQwQLVclW12DKtVflg).
## Get Involved

### Depends on
#### 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!

- [AttendanceApi](https://github.com/LiveChurchSolutions/AttendanceApi)
- [GivingApi](https://github.com/LiveChurchSolutions/GivingApi)
- [MembershipApi](https://github.com/LiveChurchSolutions/MembershipApi)
#### Join the Community
We have a great community for end-users on [Facebook]. It's a good way to ask questions, get tips and follow new updates. Come join us!

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

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.
#### Join us on Slack
If you would like to get involved contributing 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.

#### ChumsApp
#### Start Coding
If you'd like to set up the project locally, see our [development guide](https://churchapps.org/dev). The short version is:

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 f5d93e6

Please sign in to comment.