Shuunen/c-est-donne

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# C'est donné

[![Project license](https://img.shields.io/github/license/Shuunen/c-est-donne.svg?color=informational)](https://github.com/Shuunen/c-est-donne/blob/master/LICENSE)
[![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/Shuunen/c-est-donne?style=flat)](https://codeclimate.com/github/Shuunen/c-est-donne)
[![Website up](https://img.shields.io/website/https/c-est-donne.netlify.app)](https://c-est-donne.netlify.app)

> Donations between friends and relatives made easy ! Give a second life to your objects :)

![demo](docs/demo.gif)

- [C'est donné](#cest-donné)
  - [Vue 3 + TypeScript + Vite](#vue-3--typescript--vite)
  - [Recommended IDE Setup](#recommended-ide-setup)
  - [Type Support For `.vue` Imports in TS](#type-support-for-vue-imports-in-ts)
  - [Todos](#todos)
  - [Thanks](#thanks)

## Vue 3 + TypeScript + Vite

This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.

## Recommended IDE Setup

- [VS Code](https://code.visualstudio.com) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar)

## Type Support For `.vue` Imports in TS

Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can enable Volar's Take Over mode by following these steps:

1. Run `Extensions: Show Built-in Extensions` from VS Code's command palette, look for `TypeScript and JavaScript Language Features`, then right click and select `Disable (Workspace)`. By default, Take Over mode will enable itself if the default TypeScript extension is disabled.
2. Reload the VS Code window by running `Developer: Reload Window` from the command palette.

You can learn more about Take Over mode [here](https://github.com/johnsoncodehk/volar/discussions/471).

## Todos

- [ ] add activity monitor to refresh items
- [ ] add logo
- [ ] improve uvu & c8 coverage
- [ ] remove repo-check bs in eslintrc
- [ ] list header is displayed even if user has no access
- [ ] photo carousel inside cards
- [ ] show images count in cards
- [ ] dont show tutorial below list when connected, put it on a separate page
- [ ] Konami code
- [ ] favicon
- [ ] footer card should be equal in height
- [ ] transform global loading to loading button
- [ ] hide login ribbon on desktop
- [ ] set filter all by default
- [ ] visually show items status
- [ ] visually show new items
- [ ] filter given items after one month
- [ ] transform user-btn into a dropdown menu with these entries :
  - [ ] switch to light/dark mode
  - [ ] switch to english/french
  - [ ] help me
  - [ ] about the app
  - [ ] logout

## Thanks

- [Auth0](https://auth0.com) : for the auth system
- [BabelEdit](https://www.codeandweb.com/babeledit) : a great tool to translate your app
- [BlobMaker](https://www.blobmaker.app) : for the blobby shapes
- [Boxy SVG](https://boxy-svg.com) : for providing a simple & full featured svg editor
- [Eslint](https://eslint.org) : super tool to find & fix problems  
- [Github](https://github.com) : for all their great work year after year, pushing OSS forward  
- [Jake Dohm](https://dev.to/jakedohm_34/auto-registering-all-your-components-in-vue-3-with-vite-4884) : for his article on global components registration
- [Netlify](https://netlify.com) : awesome company that offers free CI & hosting for OSS projects
- [Pixel True](https://ui8.net/pixel-true-designs/products/70-beautiful-free-illustrations) : for the nice illustrations on the tutorial
- [Repo-checker](https://github.com/Shuunen/repo-checker) : eslint cover /src code and this tool the rest ^^  
- [Shields.io](https://shields.io) : for the nice badges on top of this readme
- [Shoelace](https://shoelace.style) : for their great web components library <3
- [Shuutils](https://github.com/Shuunen/shuutils) : collection of pure JS utils
- [SvgOmg](https://jakearchibald.github.io/svgomg) : awesome tool to optimize svg files
- [TailwindCss](https://tailwindcss.com) : awesome lib to produce maintainable style
- [V8](https://github.com/demurgos/v8-coverage) : simple & effective cli for code coverage
- [Vite](https://github.com/vitejs/vite) : super fast frontend tooling  
- [Vitest](https://github.com/vitest-dev/vitest) : super fast vite-native testing framework
- [Vue](https://vuejs.org) : when I need a front framework, this is the one I choose <3
- [Vue3-carousel](https://github.com/ismail9k/vue3-carousel) : nice lightweight carousel component by Abdelrahman Ismail