A React application with serverless functions for fetching random players, hosted on Netlify.
Logo | Name | Link |
---|---|---|
Typescript | https://github.com/microsoft/TypeScript | |
Vite | https://github.com/vitejs/vite | |
React | https://github.com/facebook/react | |
Vitest | https://github.com/vitest-dev/vitest | |
ESLint | https://github.com/eslint/eslint | |
Prettier | https://github.com/prettier/prettier |
Script | Description |
---|---|
dev |
Starts the development server. |
build |
Compiles TypeScript files and builds the production-ready application with Vite. |
preview |
Starts a local web server that serves the built solution from ./dist for previewing. |
prettier |
Format source code. |
test |
Runs unit tests with Vitest. |
lint |
Runs ESLint on all relevant files. |
lint:fix |
Runs ESLint on all relevant files, fixing errors and caching results. |
prepare |
Install Husky hooks. |
- Clone this repo.
git clone git@github.com:plecrx/tennis-players.git
cd tennis-players
- Install all dependencies. (yarn as default)
yarn
- Run the project with serverless functions.
netlify dev
.github/
: The deployment pipeline supported by env variable.husky/
: scripts which lint and format the staged files before committingfunctions/
: The root folder that Netlify uses to deploy serverless functionssrc/
: The application source codeassets/
: The static files (fonts, images, ...)components/
: The components which will be used in pagesdata-access/
: The requests that access APIfeatures/
: The use-cases as custom hookslayouts/
: The app layoutsrouter/
: React router configuration filespages/
: The application pagestypes/
: Global typesutils/
: Development toolsmain.tsx
: The app entry point
tests/
: The unit and integration testscomponents/
: The tests of the componentsdata-access/
: The tests of the data-accesspages/
: The tests of the pagesrouter/
: The tests of the router