Update README.md

This commit is contained in:
2025-08-02 11:02:46 +10:00
parent 9ecb438c4c
commit df90c0486c

View File

@@ -39,6 +39,36 @@ Other command aliases which will be useful for you are:
- `pnpm lint` - run ESLint on the front end codebase, to check for linting errors
- `pnpm build` - creates a production-optimised build of the Next.js app in the `.next` directory
# Attribution
Thank you to these fantastic projects, and their respective communities, without which, this application would be much worse!
- Hangfire (for background and scheduled tasks): https://www.hangfire.io
- ASP.NET Core (as the basis of our web API): https://github.com/dotnet/aspnetcore
- ServiceStack.OrmLite (as our lightweight .NET ORM): https://github.com/ServiceStack/ServiceStack/tree/main/ServiceStack.OrmLite
- PostgreSQL (as our database): https://www.postgresql.org
- TimescaleDB (as our time-series database): https://github.com/timescale/timescaledb
- Mantine (as our UI/component library): https://mantine.dev
- OpenAPI Generator (for automatic generation of front end API interfaces): https://openapi-generator.tech
- TanStack Query (as our front end query management library): https://tanstack.com/query/latest
- DefinitelyTyped (for their fantastic TypeScript type definitions): https://github.com/DefinitelyTyped/DefinitelyTyped
- Axios (as our front end HTTP client): https://axios-http.com
- Day.js (as our time/date library for the front end): https://day.js.org
- Leaflet (as our interactive map): https://leafletjs.com
- Next.js (as the basis of our SSR front end): https://nextjs.org
- React.js (as our JS framework): https://react.dev
- React Icons (for our icons!): https://react-icons.github.io/react-icons
- React Leaflet (as a minimal React wrapper for Leaflet): https://react-leaflet.js.org
- Recharts (for charts in Mantine): https://recharts.org
- Sharp (for image processing): https://sharp.pixelplumbing.com
- ESLint (for code linting): https://eslint.org
- eslint-plugin-react (for their React ESLint rules): https://github.com/jsx-eslint/eslint-plugin-react
- globals (for Node.js global variables): https://github.com/sindresorhus/globals
- Node.js (as our JS runtime): https://nodejs.org
- PostCSS (for CSS transformation in Mantine): https://postcss.org
- TypeScript ESLint (for TS linting rules): https://typescript-eslint.io
- TypeScript (as our front end language): https://www.typescriptlang.org
- PNPM (as our front end package manager): https://pnpm.io
- .NET (as the basis of our back end): https://github.com/dotnet
# TODO (in rough order of priority)
- Email notifications (WIP)
- Generalise pagination across back end code (pass in simple Pagination objects to methods, rather than the large signature we have currently)