Overview:
Swolmodoro is an app that helps users stay focused and keep moving. It provides features for development and testing, as well as deployment using GitHub Actions. The app uses Remix Stack and Cypress for testing.
Features:
- Development: The app provides an initial setup guide and instructions for installing OS and project dependencies. It also includes a Procfile to start the app in development mode and provides options to validate the app setup.
- Deployment: Swolmodoro offers GitHub Actions for automated deployment to production and staging environments. Users need to install Fly, create two apps on Fly, and add necessary tokens and secrets to their GitHub repo. The app supports database creation for both staging and production environments.
- GitHub Actions: Swolmodoro uses GitHub Actions for continuous integration and deployment. Commits to the main branch trigger deployment to the production environment, while commits to the dev branch trigger deployment to the staging environment.
- Testing: The app uses Cypress for end-to-end tests, which are stored in the test directory. Users can run these tests in development using the command "npm run test:e2e:dev" after starting the development server and the Cypress client. The app provides utilities for testing authenticated features and auto-deleting users at the end of each test. It also uses vitest for lower-level tests of utilities and individual components.
- Type Checking: Swolmodoro is built with TypeScript, and it's recommended to set up TypeScript in the editor for a better in-editor experience with type checking and auto-complete.
Summary:
Swolmodoro is a productivity app that helps users stay focused and organized. It provides development and testing features, as well as deployment capabilities using GitHub Actions. With its comprehensive installation guide and support for various testing frameworks, Swolmodoro is a valuable tool for software development teams.