willianjusten/nba-remix

NBA Remix

A simple app to show NBA games and scores/details.

Deployment

After having run the create-remix command and selected "Vercel" as a deployment target, you only need to import your Git repository into Vercel, and it will be deployed.

If you'd like to avoid using a Git repository, you can also deploy the directory by running Vercel CLI:

npm i -g vercel
vercel

It is generally recommended to use a Git repository, because future commits will then automatically be deployed by Vercel, through its Git Integration.

Development

To run your Remix app locally, make sure your project's local dependencies are installed:

npm install

Afterwards, start the Remix development server like so:

npm run dev

Open up http://localhost:3000 and you should be ready to go!

If you're used to using the vercel dev command provided by Vercel CLI instead, you can also use that, but it's not needed.

Pre-commit hook

This project uses husky for pre-commits.

To disable it, add export HUSKY_SKIP_HOOKS=1 to your shell configuration file (.zshrc, .bashrc).

Writing Components

The project favors function components using function and avoid using export default. Also, always prefer to use type instead of interface.

When creating a component then the coding style adopted by the project is like this:

export type MyComponentProps = {
  myComponentProp?: string,
}

export function MyComponent({ myComponentProp }: MyComponentProps) {
  return <>MyComponent</>
}

Maintainers

Adeonir Kohl

Flávio Silva

Helder Berto

Willian Justen