https://github.com/wralith/wuiz
Quiz application written in Java
https://github.com/wralith/wuiz
java quiz spring
Last synced: about 1 month ago
JSON representation
Quiz application written in Java
- Host: GitHub
- URL: https://github.com/wralith/wuiz
- Owner: wralith
- Created: 2023-05-10T14:17:02.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-18T21:49:10.000Z (about 3 years ago)
- Last Synced: 2025-01-13T05:41:46.402Z (over 1 year ago)
- Topics: java, quiz, spring
- Language: Java
- Homepage:
- Size: 129 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Wuiz
Quiz Application! 🧠\
Around %80-%90 Test Coverage, Isn't it sweet spot? 🍭
What this app does? Create and solve quizzes and get lovely results Check
[endpoints](#endpoints) for more.
## Development
Create Postgres Database in Docker
```bash
docker run --name wuiz --rm -d -p 5432:5432 \
-e POSTGRES_USER=wuiz \
-e POSTGRES_PASSWORD=secret \
-e POSTGRES_DB=wuiz \
postgres:alpine
```
Start Spring Application or Tests
```bash
cd server
./gradlew build -t # To watch files to restart application on change
./gradlew bootRun # Start Spring Boot application
# To run tests
./gradlew test
```
## Techs
- Java and bunch of technologies from Spring Boot umbrella
- GitHub Actions, run tests on push because why not?
- OpenAPI specs and Swagger UI for API documentation
- Postgres
## Endpoints
## Todos
- [ ] Few annotations to clean
- [ ] Refactor to follow Java best practices... _I need to do few readings for
that though_
- [ ] Exception handling and better error messages
- [ ] Dockerize App and maybe docker-compose with Postgres for better
development environment
- [ ] Frontend application maybe?
- [ ] Better result response
- [ ] Users
- [ ] Authentication
- [ ] Role to create quizzes
## Notes for Future
- Postgres is good but models seems like they would be great fit for document
database, maybe I can try CouchBase or something...
- I like folder structure as flat as possible but I don't know something seems
off.
- I believe I can break this into microservices, after I get comfortable on
building those jars, man java tooling is not the best... At least I will break
things into more modular way, Result and Quiz should not be coupled I guess.
- I don't know if I should use H2 in tests, what do you think Java people let me
know.