Blood on the Cellphone

An SMS-based app that notifies people about upcoming games of Blood on the Clocktower, gets a headcount for each event, and reminds people that games are soon.

TODO

create list of upcoming events
make button to send invites
invitation sending (currently working on this)
- for each member: make invite and send a text
handle response from members
let people change/reset their response to an invitation
reminders (eventually)
deploy this to a real server and test it out

Future feature ideas

Let members change their name
Let members unsubscribe/deactivate their account (and reactivate if they so choose)
- (Be sure we don't ever text an inactive user)
Auto-send invites a week before an event
When a new member is approved, automatically send them invitations for any upcoming games (that are within the valid invite-sending window)
Allow admins to manually send out updates to an event (time, place, other announcements)
A way to handle situation where we don't yet have enough players RSVP'd
- Plead people with reminders?
- Eventually cancel if there still not enough

Setup

You'll need to copy the .env.example file into .env and fill in the values for SESSION_SECRET, and the two Twilio values.

Note: Everything below here was the default README when I created the project. There's helpful info so I'm leaving it.

Schema

Schedule

Schedules define a particular recurring schedule of events (i.e. the first Wednesday of the month @ 7:30)

Schedules have Events that are created a 1.5 months (?) in advance. (By a daily recurring job)

Enhancement: Notification preferences operate at the Schedule level allowing people to subscribe or unsubscribe from a paricular schedule. I.e. if they are busy every wedensday, they can choose to not be notified.

Event

An event is a particular instance of a Schedule. Events have an absolute time and are the basis of Responses, and reminders.

Invitation

N number of days before an event, all (active) users are sent an invitation to which they may respond. (These will be sent by a recurring job that runs at a particular time of day. Evening or morning perhaps?)

Users can respond to a particular event indicating their intent to join, and (if they are coming) how many people they plan to bring.

A Invitation can be in one of several states:

sent
responded_yes
responded_no
responded_maybe

Reminder

Reminders are a concept but are not represented in the database. Everyone who responded yes or maybe gets a reminder the day before (or day of?) the Event reminding them. Those who responded Maybe are prompted to upgrade their response to a yes/no. (Again, a recurring job)

Other considerations

Avoidng double-sends with a simple lock?

Remix Indie Stack

Learn more about Remix Stacks.

npx create-remix@latest --template remix-run/indie-stack

What's in the stack

Fly app deployment with Docker
Production-ready SQLite Database
Healthcheck endpoint for Fly backups region fallbacks
GitHub Actions for deploy on merge to production and staging environments
Email/Password Authentication with cookie-based sessions
Database ORM with Prisma
Styling with Tailwind
End-to-end testing with Cypress
Local third party request mocking with MSW
Unit testing with Vitest and Testing Library
Code formatting with Prettier
Linting with ESLint
Static Types with TypeScript

Not a fan of bits of the stack? Fork it, change it, and use npx create-remix --template your/repo! Make it your own.

Quickstart

Click this button to create a Gitpod workspace with the project set up and Fly pre-installed

Development

This step only applies if you've opted out of having the CLI install dependencies for you:
```
npx remix init
```
Initial setup: If you just generated this project, this step has been done for you.
```
npm run setup
```
Start dev server:
```
npm run dev
```

This starts your app in development mode, rebuilding assets on file changes.

The database seed script creates a new user with some data you can use to get started:

Email: rachel@remix.run
Password: racheliscool

Relevant code:

This is a pretty simple note-taking app, but it's a good example of how you can build a full stack app with Prisma and Remix. The main functionality is creating users, logging in and out, and creating and deleting notes.

creating users, and logging in and out ./app/models/user.server.ts
user sessions, and verifying them ./app/session.server.ts
creating, and deleting notes ./app/models/note.server.ts

Deployment

This Remix Stack comes with two GitHub Actions that handle automatically deploying your app to production and staging environments.

Prior to your first deployment, you'll need to do a few things:

Install Fly
Sign up and log in to Fly
```
fly auth signup
```
Note: If you have more than one Fly account, ensure that you are signed into the same account in the Fly CLI as you are in the browser. In your terminal, run fly auth whoami and ensure the email matches the Fly account signed into the browser.
Create two apps on Fly, one for staging and one for production:
```
fly apps create blood-on-the-cellphone-8968
fly apps create blood-on-the-cellphone-8968-staging
```
Note: Make sure this name matches the app set in your fly.toml file. Otherwise, you will not be able to deploy.
- Initialize Git.
```
git init
```
Create a new GitHub Repository, and then add it as the remote for your project. Do not push your app yet!
```
git remote add origin <ORIGIN_URL>
```
Add a FLY_API_TOKEN to your GitHub repo. To do this, go to your user settings on Fly and create a new token, then add it to your repo secrets with the name FLY_API_TOKEN.
Add a SESSION_SECRET to your fly app secrets, to do this you can run the following commands:
```
fly secrets set SESSION_SECRET=$(openssl rand -hex 32) --app blood-on-the-cellphone-8968
fly secrets set SESSION_SECRET=$(openssl rand -hex 32) --app blood-on-the-cellphone-8968-staging
```
If you don't have openssl installed, you can also use 1password to generate a random secret, just replace $(openssl rand -hex 32) with the generated secret.

Create a persistent volume for the sqlite database for both your staging and production environments. Run the following:

fly volumes create data --size 1 --app blood-on-the-cellphone-8968
fly volumes create data --size 1 --app blood-on-the-cellphone-8968-staging

Now that everything is set up you can commit and push your changes to your repo. Every commit to your main branch will trigger a deployment to your production environment, and every commit to your dev branch will trigger a deployment to your staging environment.

Connecting to your database

The sqlite database lives at /data/sqlite.db in your deployed application. You can connect to the live database by running fly ssh console -C database-cli.

Getting Help with Deployment

If you run into any issues deploying to Fly, make sure you've followed all of the steps above and if you have, then post as many details about your deployment (including your app name) to the Fly support community. They're normally pretty responsive over there and hopefully can help resolve any of your deployment issues and questions.

GitHub Actions

We use GitHub Actions for continuous integration and deployment. Anything that gets into the main branch will be deployed to production after running tests/build/etc. Anything in the dev branch will be deployed to staging.

Testing

Cypress

We use Cypress for our End-to-End tests in this project. You'll find those in the cypress directory. As you make changes, add to an existing file or create a new file in the cypress/e2e directory to test your changes.

We use @testing-library/cypress for selecting elements on the page semantically.

To run these tests in development, run npm run test:e2e:dev which will start the dev server for the app as well as the Cypress client. Make sure the database is running in docker as described above.

We have a utility for testing authenticated features without having to go through the login flow:

cy.login();
// you are now logged in as a new user

We also have a utility to auto-delete the user at the end of your test. Just make sure to add this in each test file:

afterEach(() => {
  cy.cleanupUser();
});

That way, we can keep your local db clean and keep your tests isolated from one another.

Vitest

For lower level tests of utilities and individual components, we use vitest. We have DOM-specific assertion helpers via @testing-library/jest-dom.

Type Checking

This project uses TypeScript. It's recommended to get TypeScript set up for your editor to get a really great in-editor experience with type checking and auto-complete. To run type checking across the whole project, run npm run typecheck.

Linting

This project uses ESLint for linting. That is configured in .eslintrc.js.

Formatting

We use Prettier for auto-formatting in this project. It's recommended to install an editor plugin (like the VSCode Prettier plugin) to get auto-formatting on save. There's also a npm run format script you can run to format all files in the project.

Vynlar/blood-on-the-cellphone