Skip to content

plecrx/tennis-players

 
 

Repository files navigation

Tennis players App

Netlify Status

A React application with serverless functions for fetching random players, hosted on Netlify.

Tech

Logo Name Link
Typescript logo Typescript https://github.com/microsoft/TypeScript
Vite logo Vite https://github.com/vitejs/vite
Vue 3 logo React https://github.com/facebook/react
Vitest logo Vitest https://github.com/vitest-dev/vitest
ESLint logo ESLint https://github.com/eslint/eslint
Prettier logo 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.

Get started

  1. Clone this repo.
git clone git@github.com:plecrx/tennis-players.git
cd tennis-players
  1. Install all dependencies. (yarn as default)
yarn
  1. Run the project with serverless functions.
netlify dev

Project structure

  • .github/ : The deployment pipeline supported by env variable
  • .husky/ : scripts which lint and format the staged files before committing
  • functions/ : The root folder that Netlify uses to deploy serverless functions
  • src/ : The application source code
    • assets/ : The static files (fonts, images, ...)
    • components/ : The components which will be used in pages
    • data-access/ : The requests that access API
    • features/ : The use-cases as custom hooks
    • layouts/ : The app layouts
    • router/ : React router configuration files
    • pages/ : The application pages
    • types/ : Global types
    • utils/ : Development tools
    • main.tsx : The app entry point
  • tests/ : The unit and integration tests
    • components/ : The tests of the components
    • data-access/ : The tests of the data-access
    • pages/ : The tests of the pages
    • router/ : The tests of the router

Author

Prescilla Lecurieux

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 94.6%
  • JavaScript 3.4%
  • HTML 1.5%
  • Other 0.5%