Skip to content

2manoj1/link-previewer

Repository files navigation

Link Previewer

Link Previewer Demo App -> Click here

Page 1 Page 2
Link Preview page 1 Link Preview Details page

Demo:

Screen.Recording.2022-08-02.at.2.44.34.PM.mov

Build using Remix Stacks.

npx create-remix --template remix-run/blues-stack

What's in the stack

Not a fan of bits of the stack? Fork it, change it, and use npx create-remix --template your/repo! Make it your own.

Quickstart

Click this button to create a Gitpod workspace with the project set up, Postgres started, and Fly pre-installed

Gitpod Ready-to-Code

Development

  • This step only applies if you've opted out of having the CLI install dependencies for you:

    npx remix init
  • Start the Postgres Database in Docker:

    yarn docker

    Note: The yarn script will complete while Docker sets up the container in the background. Ensure that Docker has finished and your container is running before proceeding.

  • Initial setup: (Data proxy prisma)

      npx prisma generate --data-proxy

    or (If only local database)

    yarn setup
  • Run the first build:

    yarn build
  • Start dev server:

    yarn dev

Vitest

For lower level tests of utilities and individual components, we use vitest. We have DOM-specific assertion helpers via @testing-library/jest-dom.

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 yarn typecheck.

Linting

This project uses ESLint for linting. That is configured in .eslintrc.js.

Formatting

We use Prettier for auto-formatting in this project. It's recommended to install an editor plugin (like the VSCode Prettier plugin) to get auto-formatting on save. There's also a yarn format script you can run to format all files in the project.