Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/willianjusten/nba-remix
A simple app to show NBA games and scores/details.
https://github.com/willianjusten/nba-remix
nba remix typescript
Last synced: about 1 month ago
JSON representation
A simple app to show NBA games and scores/details.
- Host: GitHub
- URL: https://github.com/willianjusten/nba-remix
- Owner: willianjusten
- Created: 2022-02-03T01:50:04.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-20T00:12:48.000Z (6 months ago)
- Last Synced: 2024-04-15T00:45:01.419Z (2 months ago)
- Topics: nba, remix, typescript
- Language: TypeScript
- Homepage: https://nba.willianjusten.com.br
- Size: 1.22 MB
- Stars: 207
- Watchers: 8
- Forks: 32
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
Lists
- Awesome-Remix - NBA Remix - [website](https://nba.willianjusten.com.br/) (Build with Remix)
README
## NBA Remix
[](https://github.com/willianjusten/nba-remix/actions/workflows/ci.yml)
> 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](https://vercel.com/new) 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](https://vercel.com/cli):
```sh
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](https://vercel.com/docs/concepts/git).
## Development
To run your Remix app locally, make sure your project's local dependencies are installed:
```sh
npm install
```
Afterwards, start the Remix development server like so:
```sh
npm run dev
```
Open up [http://localhost:3000](http://localhost:3000) and you should be ready to go!
If you're used to using the `vercel dev` command provided by [Vercel CLI](https://vercel.com/cli) instead, you can also use that, but it's not needed.
## Pre-commit hook
This project uses [husky](https://www.npmjs.com/package/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:
```js
export type MyComponentProps = {
myComponentProp?: string,
}
export function MyComponent({ myComponentProp }: MyComponentProps) {
return <>MyComponent>
}
```
## Maintainers
