Surreal Stack
Remix Stack using SurrealDB
Overview
The Remix Surreal Stack is a full stack development framework that offers a comprehensive set of features for building web applications. It provides multi-region deployment with Docker, a PostgreSQL cluster, healthcheck endpoints, and GitHub Actions for streamlined deployment. It also includes features such as email/password authentication with cookie-based sessions, a database ORM with Prisma, styling with Tailwind, and end-to-end testing with Cypress. The stack also supports local third-party request mocking with MSW, unit testing with Vitest and Testing Library, and code formatting and linting with Prettier and ESLint. The stack is highly customizable, allowing users to fork and modify it to fit their specific needs. The quickstart guide provides a seamless setup process using Gitpod, Docker, and the Fly deployment tool. The development process involves starting the Surreal Database in Docker, running the first build, and starting the development server.
Features
- Multi-region Fly app deployment with Docker
- Multi-region Fly PostgreSQL Cluster
- 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
- Customizable stack with the ability to fork and modify
Summary
The Remix Surreal Stack is a powerful full stack development framework that offers a wide range of features for building web applications. It provides seamless multi-region deployment, robust PostgreSQL cluster support, and automated deployment via GitHub Actions. The stack also includes essential features like authentication, database management, styling, and testing. With its customizable nature, developers can easily tailor the stack to their specific requirements. The installation process is straightforward, thanks to the provided Gitpod workspace and Docker setup. Overall, the Remix Surreal Stack provides developers with a solid foundation for building efficient and scalable web applications.
- Express
Express.js is a simple Node.js framework for single, multi-page, and hybrid web applications.
- React
React is a widely used JavaScript library for building user interfaces and single-page applications. It follows a component-based architecture and uses a virtual DOM to efficiently update and render UI components
- Vite
Vite is a build tool that aims to provide a faster and leaner development experience for modern web projects
- Tailwind
Tailwind CSS is a utility-first CSS framework that provides pre-defined classes for building responsive and customizable user interfaces.
- Eslint
ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.
- Postcss
PostCSS is a popular open-source tool that enables web developers to transform CSS styles with JavaScript plugins. It allows for efficient processing of CSS styles, from applying vendor prefixes to improving browser compatibility, ultimately resulting in cleaner, faster, and more maintainable code.
- Typescript
TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.