Skip to content

Commit

Permalink
Remove remix.init functionality
Browse files Browse the repository at this point in the history
People should just clone or use the template repositor via the github UI.
  • Loading branch information
ahuth committed Sep 7, 2024
1 parent 3025347 commit c4a500e
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 111 deletions.
40 changes: 4 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,16 @@
# Remix Andrew Stack

<!-- DELETE-START -->
[Remix](https://remix.run) template for creating full-stack apps.
<!-- DELETE-END -->

## Table of contents

<!-- DELETE-START -->
- [Using this template](#using-this-template)
- [What's in the template](#what-s-in-the-template)<!-- DELETE-END -->
- [Tech stack](#tech-stack)
- [Requirements](#requirements)
- [Setup](#setup)
- [Development](#development)
- [Troubleshooting](#troubleshooting)

<!-- DELETE-START -->
## Using this template

Create an app from this template by running:

```sh
npx --yes create-remix@latest --yes --template ahuth/andrew-stack
```

## What's in the template
## 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
Expand All @@ -40,7 +27,6 @@ npx --yes create-remix@latest --yes --template ahuth/andrew-stack
- [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
<!-- DELETE-END -->

## Requirements

Expand All @@ -49,7 +35,7 @@ npx --yes create-remix@latest --yes --template ahuth/andrew-stack

## Setup

After cloning the repo, setup the app by following these steps.
Setup the app by doing the following:

- Install the required Node version

Expand All @@ -69,8 +55,6 @@ After cloning the repo, setup the app by following these steps.
npm run docker
```

> **Note:** Ensure that Docker has finished and your containers are running before proceeding.
- Setup the database:

```sh
Expand All @@ -97,7 +81,7 @@ After cloning the repo, setup the app by following these steps.
https://localhost:3000
```

- By default there is a new user with some data you can use to get started:
- By default there's a user with some data you can use to get started:
- Email: [email protected]
- Password: password

Expand All @@ -113,19 +97,3 @@ After cloning the repo, setup the app by following these steps.
| 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`.

## Troubleshooting

Something's gone awry 🤨? Try these steps:

- Re-build the Remix server

```sh
npm run build
```

- Re-install all dependencies (a "clean install")

```sh
npm ci
```
1 change: 0 additions & 1 deletion remix.init/.gitignore

This file was deleted.

69 changes: 0 additions & 69 deletions remix.init/index.js

This file was deleted.

5 changes: 0 additions & 5 deletions remix.init/package.json

This file was deleted.

0 comments on commit c4a500e

Please sign in to comment.