https://github.com/gemisis/wedding-website
https://github.com/gemisis/wedding-website
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/gemisis/wedding-website
- Owner: GEMISIS
- License: mit
- Created: 2022-02-22T03:49:35.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-05-31T06:10:25.000Z (about 4 years ago)
- Last Synced: 2025-01-22T14:32:18.760Z (over 1 year ago)
- Language: TypeScript
- Size: 2.71 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# My Wedding Website
## Overview
This is the website used for registering guests for my wedding. Because of COVID-19, we wanted to ensure all of our guests were vaccinated, and thus needed a custom website at the time to handle this with our other registration information.
## Technical Design
The project uses CDK to deploy via AWS, which hosts a very simple React website that users can interact with. An architecture diagram of the website can be seen below:
For the database, we need to store several pieces of information. Because we don't want to worry about sending registration codes for people, we instead decided to use pieces of information known to the users to register. Thus, the database needs to reflect this, and be able to handle conflicting scenarios.
The primary info we will use is a person's name and address numbre. This can result in conflicts however, so we will need sub-objects for each family to be in. To that end, the structure of the table that has been chosen looks like so:
| Key Type | Name | Data Format | Sample Value | Description |
| ------------- | -------------- | ---------------------- | --------------------------------- | ------------------------------------------------------------------------------------- |
| Partition Key | Address Number | String | 1337 | The number on their home for the address this family lives at. |
| List of Items | Families | List of Family Objects | [[Object Object],[Object Object]] | A list of family objects. This is because multiple famlies can live in the same home. |
A family object will look like so:
```json
{
'people': [
{
'firstName': 'John',
'lastName': 'Doe',
'attending': true,
'isChild': false,
'entree': 'vegetarian',
'vaxStatus': 'Vaccinated'
},
{
'firstName': 'Jane',
'lastName': 'Doe',
'attending': true,
'isChild': false,
'entree': 'beef',
'vaxStatus': 'Boosted'
}
],
'email': 'john.doe@gmail.com',
'phoneNumber': '111-111-1111'
}
```
## Setup
You will need to install the following before you can use this project:
- AWS CDK (Cloud Development Kit)
- Lerna
Once you have these both installed, run `lerna bootstrap` and `lerna run bootstrap` to bootstrap the necessary dependencies and CDK configurations. Finally, update the configuration in `packages/website/src/config.json` with your information.
### Building
To begin, you need to run `lerna run build` in order to compile all of the necessary code. Lerna will automatically determine the necssary dependencies and the order in which to build everything.
### Deploying
When you are ready to deploy, begin by synthesizing the CDK templates with `lerna run synth`. Then, simply run `lerna run deploy` to deploy everything!
### Testing Locally
To test the website locally, run `lerna run start --stream` to open a local version of the website. Note that you will need to have deployed the APIs at least once to test locally.
### Converting Excel Sheets
To convert an Excel Spreadsheet, you can use `lerna run convert -- -- --filename=X --tablename=Y` where `X` is the name of the spreadsheet file and `Y` is the name of the DynamoDB table created when deploying, to create a JSON file output.
## Commands
### lerna run build
Builds everything required for the site. Will output a build folder for the website, and a bin folder for the cdk project.
### lerna run config
Runs the configurator to configure the project with project specific variables.
### lerna run synth
Synthesizes the CDK project to be deployed.
### lerna run bootstrap
Bootstrap the CDK project so that it is deployed to your account.
### lerna run deploy
Deploys the previously synthesized CDK project. This effectively deploys the entire website.
### lerna run start
Runs the website to be tested locally, instead of requiring an entire deployment each time. Note however that this will only run the website files, and that any APIs will still need to be deployed at least once before testing locally will work.