Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ahuth/andrew-stack
Remix template with Postgres, auth, testing, linting, formatting, etc.
https://github.com/ahuth/andrew-stack
Last synced: 4 days ago
JSON representation
Remix template with Postgres, auth, testing, linting, formatting, etc.
- Host: GitHub
- URL: https://github.com/ahuth/andrew-stack
- Owner: ahuth
- License: mit
- Created: 2023-08-05T12:23:04.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-14T12:42:03.000Z (2 months ago)
- Last Synced: 2024-09-15T16:15:42.598Z (2 months ago)
- Language: TypeScript
- Homepage:
- Size: 3.01 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Remix Andrew Stack
[Remix](https://remix.run) template for creating full-stack apps.
## Table of contents
- [Tech stack](#tech-stack)
- [Requirements](#requirements)
- [Setup](#setup)
- [Development](#development)
- [Troubleshooting](#troubleshooting)
## Tech stack
- Email/Password authentication with [cookie-based sessions](https://remix.run/docs/en/v1/api/remix#createcookiesessionstorage)
- [Conform](https://conform.guide/) for Progressively Enhanced and fully type safe forms
- [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/) containerization
- [ESLint](https://eslint.org) for linting
- [GitHub Actions](https://github.com/features/actions) for CI
- [Playwright](https://playwright.dev/) for integration tests
- [PostgreSQL](https://www.postgresql.org/) database
- [Prettier](https://prettier.io) code formatting
- [Prisma](https://prisma.io) database ORM
- [shadcn/ui](https://ui.shadcn.com/) React component library
- [Storybook](https://storybook.js.org/) component explorer
- [Tailwind](https://tailwindcss.com/) for styling ❤️
- [TypeScript](https://typescriptlang.org) for type safety!
- [Vitest](https://vitest.dev) and [Testing Library](https://testing-library.com) for unit testing
- [Zod](https://zod.dev/) for Runtime schema validation
## Requirements
- [Docker](https://www.docker.com/)
- [nodenv](https://github.com/nodenv/nodenv)
## Setup
Setup the app by doing the following:
- Install the required Node version
```sh
nodenv install
```
- Install dependencies
```sh
npm install
```
- Start any required Docker services, such as Postgres:
```sh
npm run docker
```
- Setup the database:
```sh
npm run setup
```
- Run the build, which generates the App's Node server:
```sh
npm run build
```
## Development
- Start the app in development mode, rebuilding assets on file change:
```sh
npm start
```
- Once running, visit:
```
https://localhost:3000
```
- By default there's a user with some data you can use to get started:
- Email: [email protected]
- Password: password
- Manage the database with the Prisma CLI. See [Developing with Prisma Migrate](https://www.prisma.io/docs/guides/database/developing-with-prisma-migrate).
Some common operations are:
| Goal | Command(s) |
| ---- | ---------- |
| Apply pending migrations | `npm run prisma migrate dev` |
| Add a new model | Modify prisma/schema.prisma and run `npm run prisma migrate dev` to generate a migration |
| Explore the db | `npm run prisma studio` |
| Reset your db | `npm run prisma migrate reset` |
- Debug server side code by placing a `debugger` in your code, open up Chrome, and go to `chrome://inspect`.