ChurchApps

## NPM Project Setup

We have four projects that contain reusable code that is shared across the other projects. These are:

- [@churchapps/helpers](https://github.com/LiveChurchSolutions/Helpers/){:target="_self" .} - Code that is useful across platform. Examples include working with arrays, currency, dates, error handling, users, and donations.
- [@churchapps/apihelper](https://github.com/LiveChurchSolutions/ApiHelper/){:target="_self" .} - Node.js helper functions. Includes error logging, authentication, a base class for controllers, MySql, email, and encryption.
- [@churchapps/apphelper](https://github.com/LiveChurchSolutions/AppHelper/){:target="_self" .} - React and Next.js helper functions. Includes code for calling APIs, analytics, file upload, url slugs, and web sockets.
- [@churchapps/mobilehelper](https://github.com/LiveChurchSolutions/MobileHelper/){:target="_self" .} - ReactNative helper functions. Includes code for calling APIs, App Center, mobile styling and dimensions and validation.



Building these projects is as simple as running. `npm i` and `npm build`

### Testing

The easiest way to test is with npm link:

1. After making changes run `npm run build` followed by `npm link` to expose the package locally.
2. In your test project run `@npm link @churchapps/mobilehelper` or the name of the package you wish to test.
3. Rerun both after changes.

***Note:** On occassion NPM link just fails to work. The workaround for now is a batch file to manually compile the changes and place them in the node_modules folder*

`cd AppHelper`
`call npm run build`
`cd dist`
`xcopy * d:\sourcecode\lcs\b1\b1app\node_modules\@churchapps\apphelper\dist\ /s /e /y`
`cd ..`
`cd src`
`xcopy * d:\sourcecode\lcs\b1\b1app\node_modules\@churchapps\apphelper\src\ /s /e /y`
`cd ..`
`cd ..`
`rmdir d:\sourcecode\lcs\b1\b1app\.next\cache /s /q`
`echo "Done"`


### Deployment

You must have permission on npmjs to deploy. If you do, the steps are:

1. Update the version number in package.json
2. Run `npm run build`
3. Run ``npm publish --access=public``



## Docker Setup

See [setup video](https://youtu.be/M81I6gmKqdI){:target="_blank" .}.

Docker isn't required for any of the projects, but it does make setting up the Core APIs (Access, Attendance, Giving, Membership, and Reporting) that are needed by most projects much easier. Without Docker, you need to setup each of these projects manually then every time you wish to run them you must launch for command prompts running each of these APIs in addition to any other projects you need to run. Docker will do all this automatically in the background. It is possible to run all of the projects, including web, fully within Docker. However, it consumes a lot of RAM. It's recommended to just launch the Core Apis with it. To do so:

### Additional Commands

- Build and start the Docker container for the first time: `docker-compose up -d`
- Stop the Docker container: `docker-compose stop`
- Restart the docker container: `docker-compose start`
- Reset everything except MySql: `docker-compose down` followed by `docker-compose build --no-cache` and `docker-compose up -d`
- Reset everything including MySql: `docker-compose down -v` followed by `docker-compose build --no-cache` and `docker-compose up -d`
- Completely reinstall everything: `docker-compose down --rmi local` followed by `docker-compose build --no-cache` and `docker-compose up -d`

## Creating an Account

See [setup video](https://youtu.be/LjeSzT7OXw4){:target="_blank" .}.

On production when you create a user account it generates a temporary password and emails it to you. Since you will not have a mail server set up on your dev machine, you have to do a little more work to get this temporary password:

1. Get the api and web project(s) running.
2. Open the Docker drawer in VS Code and right click on MembershipApi.
3. Choose 'View Logs'.
4. Register an account in the web app you're working with.
5. The welcome email with your temporary password will be displayed in the log.
6. Login with the temp password and it'll prompt you to search for a church.
7. There are no churches in your local database yet so create a new one.

If you wish to change your temporary password, launch the Chums project, log in and manage your account.

## Desktop Project Setup

We currently have one desktop application of [FreeShow](https://github.com/ChurchApps/FreeShow){:target="_self" .}. It is also written in a Typescript using Electron, which provides the cross-platform capabilities. It utilizes Svelte for the UI. Unlike the mobile and web projects, this one is stand-alone and does not depend on any of the APIs above. Setup is very easy:

- Clone the the repo from GitHub.
- Install the dependencies with: `npm install`
- Run `npm start` to start Electron server