https://github.com/ethanf108/quotefault-v2-frontend
Rewrite of Quotefault but without templates this time.
https://github.com/ethanf108/quotefault-v2-frontend
docker eslint nginx prettier react typescript vite
Last synced: 5 months ago
JSON representation
Rewrite of Quotefault but without templates this time.
- Host: GitHub
- URL: https://github.com/ethanf108/quotefault-v2-frontend
- Owner: ethanf108
- Created: 2023-10-21T15:48:34.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-03-12T13:58:12.000Z (over 2 years ago)
- Last Synced: 2024-04-19T17:23:29.243Z (about 2 years ago)
- Topics: docker, eslint, nginx, prettier, react, typescript, vite
- Language: TypeScript
- Homepage: https://quotefault.csh.rit.edu
- Size: 246 KB
- Stars: 0
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.org
Awesome Lists containing this project
README
* Quotefault v2
** What is Quotefault?
[[https://quotefault.csh.rit.edu][Quotefault]] is a Quote Database for out-of-context quotes spoken by members of
[[https://csh.rit.edu][Computer Science House]].
** Why is v2?
[[https://github.com/ComputerScienceHouse/Quotefault/][Original Quotefault]] was written by [[https://github.com/dantayy][user:dantayy]] in (supposedly) one weekend. It
was a great piece of software, but it was decided that it must be rewritten to
support a more modern client-server architecture, instead of the template format
it used previously.
** What is v2?
Features added:
1. Multi-user quotes
2. Infinite scrolling (finally)
3. Search
4. More Search (!)
5. Report reasons
** How is Quotefault v2?
*** Frontend
The Quotefault frontend is a React web app using Typescript.
Other technologies used:
- ~vite~ :: Build system. Very fast :)
- ~eslint~ :: Linter, used to make sure code is good quality
- ~prettier~ :: Standardizes the code format
- ~docker~ :: For deployment on CSH's Kubernetes cluster
- ~nginx~ :: Used in the Docker build process, for VERY fast hosting
*** Backend
[[https://github.com/costowell/quotefault-backend][bye :)]]
* Dev Setup
1. Make sure you have ~npm~ installed
2. Run ~npm ci~ to download dependancies
1. This should automatically configure the ~git~ hooks, but check your ~git~
config (~git config -l~) to make sure ~core.hookspath~ is set to
~git-hooks~
3. To run the app, run ~npm run dev~