Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/charles-clerk-dev/new-wave-stack
Custom Remix stack using Clerk for authentication and full user management.
https://github.com/charles-clerk-dev/new-wave-stack
clerk clerkauth clerkdev custom-remix cypress faunadb jest netlify new-wave remix-stack remix-stacks tailwindcss typescript
Last synced: 4 months ago
JSON representation
Custom Remix stack using Clerk for authentication and full user management.
- Host: GitHub
- URL: https://github.com/charles-clerk-dev/new-wave-stack
- Owner: charles-clerk-dev
- Created: 2022-05-21T17:17:06.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-07-14T18:14:43.000Z (over 2 years ago)
- Last Synced: 2024-08-01T02:34:14.960Z (7 months ago)
- Topics: clerk, clerkauth, clerkdev, custom-remix, cypress, faunadb, jest, netlify, new-wave, remix-stack, remix-stacks, tailwindcss, typescript
- Language: JavaScript
- Homepage: https://new-wave-stack.netlify.app/
- Size: 1.57 MB
- Stars: 15
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-remix - New Wave Stack
- awesome-remix - New Wave Stack
README
# New Wave Stack
Learn more about [Remix Stacks](https://remix.run/stacks).
For more on our thoughts on the New Wave Stack check out our [blog post.](https://clerk.dev/blog/new-wave-stack)
To view this template in deployment visit: [new-wave-stack.netlify.app](https://new-wave-stack.netlify.app/)
## What's in the stack
- [Netlify Deployment](https://www.netlify.com/)
- Email/Password Authentication with [Clerk](https://clerk.dev/)
- Document-relational database with [Fauna](https://fauna.com)
- Styling with [Tailwind](https://tailwindcss.com/)
- End-to-end testing with [Cypress](https://cypress.io)
- Unit testing with [Jest](https://jestjs.io/) and [Testing Library](https://testing-library.com)
- Code formatting with [Prettier](https://prettier.io)
- Linting with [ESLint](https://eslint.org)
- Static Types with [TypeScript](https://typescriptlang.org)
## Development
### Sign Up with Clerk
**[Sign up with Clerk](https://dashboard.clerk.dev/sign-up)** if you haven't already.
### Create a new Clerk application
Create a new application from the Clerk dashboard. Check out the Clerk docs for more information about **[setting up your Clerk application.](https://clerk.dev/docs/how-to/set-up-your-application)**
### Create a new application using the New Wave Stack Template:
```sh
npx create-remix@latest --template charles-clerk-dev/new-wave-stack
```
### Navigate into your project directory
```sh
cd
```
### Create a `.env` file.
```sh
touch .env
```
### Find your **[Frontend API key and Backend API key](https://dashboard.clerk.dev/last-active?path=api-keys)** on the Dashboard and add them to that file like this:
```
CLERK_FRONTEND_API=
CLERK_API_KEY=
```
### Install Netlify CLI
If you don't already have the Netlify CLI downloaded, run:
```she
npm i -g netlify-cli@latest
```
### Trigger an initial build
```sh
npm run build
```
### Start your development instance
```sh
npm run dev
```
Visit http://localhost:3000/. If everything is set up correctly, you should see something that looks like this:
That's it! You're all set to start building your Remix application with complete user management provided by Clerk.
## Database
This template comes pre-configured to make calls to a **[Fauna database](https://fauna.com/)**
To make authenticated calls to a Fauna database, you'll need to use one of Clerk's handy **[JWT Templates](https://clerk.dev/docs/how-to/jwt-templates)**. Check out our **[detailed instructions about setting up Clerk and Fauna](https://clerk.dev/docs/integration/fauna)**).
For a better understanding about how Fauna works with Remix and Clerk, it is highly recommend to work through Clerk's **[Remix/Clerk/Fauna Tutorial](https://clerk.dev/tutorials/build-movie-emoji-quiz-with-remix-fauna-and-clerk)**
## Styling
This template is pre-configured to use Tailwind styling. For more information about Tailwind classes and core concepts, check out the **[Tailwind documentation](https://tailwindcss.com/docs)**.
## Deployment
This template uses Netlify for deployment. Setting up your Remix app to deploy with Netlify couldn't be easier. **[Step by step instructions can be found here](https://www.netlify.com/blog/how-to-deploy-remix-apps-on-netlify/)**, and deployment only takes minutes.
## Testing
### Cypress
We use Cypress for our End-to-End tests in this project. You'll find those in the `cypress` directory. We've included Cypress's example files to help you on your way, but for more information on Cypress, **[check out their official documentation](https://docs.cypress.io/guides/core-concepts/introduction-to-cypress)**.
### Jest/Testing Library
For lower level tests of utilities and individual components, we use [Jest](https://jestjs.io/) and [Testing Library](https://testing-library.com).
### 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](https://prettier.io/) for auto-formatting in this project. It's recommended to install an editor plugin (like the [VSCode Prettier plugin](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)) to get auto-formatting on save. There's also a `npm run format` script you can run to format all files in the project.