brunodmartins / church-members-api

A simple API to manage church's members

church-members-api ⛪️

A simple application to manage a church's members.

Features 💻

• Member's control (register & search)
• Member's report
  • Legal members (all except children)
  • All members (including children)
  • By classification
  • Birthdays list
  • Marriage list
• Notification jobs
  • Weekly births through email
  • Dailly birthdays through SMS
• i18n
  • Supports pt-BR and en-US

Libraries ⚙️

• Viper
• go-age
• AWS SDK v2
• gopdf
• nicksnyder-i18n
• logrus

Deploy ✈️

The application was build upon a Docker image, but rely mostly on AWS resources to work. To deploy on AWS, simple configure a Terraform with some vars described bellow and run the script and it's all done!

AWS ☁️

The following resources are used on AWS

• DynamoDB to store churchs, users and members information
• S3 to store report files
• Event Bridge to CRON the jobs
• SNS to send notifications from jobs
• ECR to store a private image of the application
• Lambda to run the serverless application (both API and JOB)
• API Gateway to provide a RESTfull interface and authorize access

Configuration 🛠

The following configuration are required through Terraform vars

Terraform var	Environment variable	Description
Hard coded on Terraform	SERVER	Used to define the environment where the application will run. Defaults to AWS
Hard coded on Terraform	APPLICATION	Used to defined the Lambda type: API or JOB
Terraform takes it from dynamo resource	TABLE_MEMBER	DynamoDB members table
Terraform takes it from dynamo resource	TABLE_USER	DynamoDB users table
Terraform takes it from dynamo resource	TABLE_CHURCH	DynamoDB churchs table
Terraform takes it from SNS resource	REPORTS_TOPIC	The topic to notify weekly jobs through email
Terraform takes it from S3 resource	STORAGE	The S3 bucket

Support ✉️

You can create a PR for it =)

church-members-api's Issues

Member edition

Members data change, thus, this API should support it.

A new endpoint should exist, allowing data to be modified. Contact, Address and Personal data should each have its own endpoint allowing the modification.

Contact interface

PUT /members/{id}/contact

Request should follow the current structure Contact struct , allowing the cellphone, phone and email to be modified.

Address interface

PUT /members/{id}/address

Request should follow the current structure Address struct.

Person interface

PUT /members/{id}/person

Request should allow the following modifications:

• name (first and last)
• birth date
• marriage date + spouses name
• children quantity

Run the application locally

Currently the application is not able to be executed locally, it requires a full connectivity with AWS resources.

It should be able to run locally, even without internet, abstracting most external components such as S3 and DynamoDB. Localstack shoud be an option

Church module

Members Anniversary as Calendar

Is your feature request related to a problem? Please describe.

Currently, anniversaries are sent as sms text messages to users that check the functionality

Describe the solution you'd like

A public calendar could be exported, and downloaded independently and used on any smartphone, relying entirely on an Offline app.

Describe alternatives you've considered

A public calendar server could be used to keep in sync always.

Additional context
Add any other context or screenshots about the feature request here.

Create GSI for birthDateShort searchs

Use VPC Endpoints

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Church module

Is your feature request related to a problem? Please describe.

Today, the application supports only membership related to a single church, managed by the environment variables.

Describe the solution you'd like

A church module could be added, allowing the application to support many church. Doing so, members and users would be associated to a Church.

Describe alternatives you've considered

Tasks required

• #62
• #63
• #64
• #66
• #65
• #67
• #68
• #69
• #70

Use semver and releases

Currently there is no version concepts, nor releases.

It would be wise to start generating versions based on the semver model.

• Major releases providing new features with breaking changes on any interfaces
• Minor releases providing new features without breaking changes on any interfaces
• Patches releases contains internal changes, libraries upgrades etc.

Update Readme

Is your feature request related to a problem? Please describe.

After deprecating the Cognito, the README documentation was not updated

Describe the solution you'd like

The README must be updated to show the true state of the application

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Pass user to JWT

Remove environment variables referencing the church (church_name, church_name_short, app_lang)

Improve email template

Describe the solution you'd like
The weekly email should contain a minimal UX, providing a good HTML formatting. Despite that, an unsubscribe link should exist on it.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Church creation flow

How it works today

A manual script must be executed to create a church directly into the database.

How it should work

A new endpoint should exist, allowing the creation of a church. New fields should be required:

• Church name
• Church abbreviation (unique)
• Address
• Email
• Admin username (unique)

After the validations are performed, the church must be inserted into the table, and a new user shall be created for it, using the admin username request. An email will be sent for the user requesting it to reset its password with a new one, and it will be ready for usage.

Jobs operating to each church

Create GSI for name searchs

i18n per request

Is your feature request related to a problem? Please describe.

Translation is tied to an application environment, which leads to no scale well.

Describe the solution you'd like

Translation should be tied to the accept-language header, or the church configuration.

Describe alternatives you've considered

• It should be created an middleware to load the i18n locator into the golang context.
• The i18n service should use the locator inside the current context

Additional context
Add any other context or screenshots about the feature request here.

Modify operations to use `church_id`

Create new endpoints to obtain the report file

Change report feature to save its data on S3

Created S3 bucket

Recreate DynamoDB tables to use Indexes

• Create new tables for restoring data
• #72
• #74
• #75
• Restore data from backup table
• Revert to on-demand usage on tables
• Modify Specifications to use new index
• Modify GetItem operations

Obtain church from JWT

Add `church_id` into user table

Reports saved on S3

Is your feature request related to a problem? Please describe.

Today, every time a user requests a report (legal or birthday lists, for example), the application runs a query on DynamoDB to extract all of its data. This process consumes RCU from the database without need.

The members table has much more reads then writes, thus, the data rarely changes. With organizations coming (#44), many church's could start using the API, making more unnecessary reads to the main table.

Describe the solution you'd like

This whole process could be a new endpoint, where the user generates a report that will be kept on a storage solution, like S3. A private bucket could contain all reports generated, allowing users to request a signed URL to download it on its personal devices or send to other church's members that need this information. The main advantage is the fact that the generated file will be kept on the storage, the disadvantaged is that the report could contain stale data (or even miss members) until someone regenerates it. I believe this must be accepted for the needs of having the church information at hands, not relying on the application!

Describe alternatives you've considered

A automated workflow could be created, generating the required reports every time a member is modified or added into the church.

Tasks required

• #59
• #61
• #60

Use a Email Service for notifications

Is your feature request related to a problem? Please describe.

Today the application is using a SNS topic to notify emails about weekly reports. This leads to a not so good email, having a generic subject from AWS, and also SNS email does not support a good HTML formatting

Describe the solution you'd like

A properly email service should be used to send emails. The application could leverage SES to do so.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Revamp IaC

Currently, Terraform scripts provide all the necessary infrastructure at AWS, plus, the initial deploy required to build the Lambda runtime. This lead to some problems that are not scaling:

• It's not easy to create a new testing environment
• Initial infrastructure creation requires an ECR with an image to create the Lambda. The ECR is also defined together within the script.
• Resources names are hard coded, leading to the initial problem.

To solve that problems, it should be revamped as follows:

• Extract ECR to a isolated shared module
• Put all resources into a common module
• Tag resources using application:{name} and environment:{value}
• Import the current resources using the module, tagging as environment:production

Recreate tables with Partition Key (church_id) and SortKey (id)

Add organization module

Subscribe email confirmation

Upon creating a new user for the system (admin church user or common user), a confirmation email should be sent for the given email. The user shall have a status flag, requiring him to confirm the email to change it. After the email confirmation, the user should be authorized to access the system

• Send email for the user
• Modify user creation flow
• Store confirmation link
• Create endpoint to perform the confirmation operation
• Modify login operation to allow only confirmed users

Add `church_id` into member table