Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/naren-jha/betterreads
Cassandra demo app - BetterReads
https://github.com/naren-jha/betterreads
cassandra cassandra-cql github-login spring-boot
Last synced: about 1 month ago
JSON representation
Cassandra demo app - BetterReads
- Host: GitHub
- URL: https://github.com/naren-jha/betterreads
- Owner: naren-jha
- Created: 2022-10-26T18:14:33.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-08-01T20:23:13.000Z (over 1 year ago)
- Last Synced: 2024-11-06T01:50:58.231Z (3 months ago)
- Topics: cassandra, cassandra-cql, github-login, spring-boot
- Language: Java
- Homepage:
- Size: 147 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# betterreads
Cassandra demo app - BetterReads (Similar to GoodReads). Data is first loaded into datastax Cassandra cluster using [this app](https://github.com/njha-collab/betterread-data-loader)
[Design Doc](https://drive.google.com/file/d/13FBXQvcFNA_kmeAHeVjPMQ5xwrpDZM-g/view?usp=sharing)
### Cassandra Docs
* https://cassandra.apache.org/doc/latest/
* https://cassandra.apache.org/doc/latest/cassandra/data_modeling/index.html
* https://www.datastax.com/blog/basic-rules-cassandra-data-modeling
* https://www.datastax.com/blog/coming-12-collections-support-cql3
* https://www.datastax.com/blog/cql-improvements-cassandra-21
* https://www.datastax.com/blog/whats-new-cassandra-21-better-implementation-counters
* https://www.datastax.com/blog/lightweight-transactions-cassandra-20
* https://www.datastax.com/examples
* https://www.datastax.com/examples/astra-netflix
* https://www.datastax.com/examples/astra-tik-tok
* https://youtu.be/fcohNYJ1FAI
* https://youtu.be/u6pKIrfJgkU
* https://academy.datastax.com/#/courses/c5b626ca-d619-45b3-adf2-a7d2b940a7ee
* https://www.datastax.com/blog/putting-some-structure-storage-engine
### GitHub User authentication setup
Follow this [video](https://youtu.be/nwyf_4aSkqM) and [this](https://github.com/koushikkothagal/spring-github-login-starter) (or [this](https://github.com/koushikkothagal/spring-reactive-github-login-starter)) github repositories to build oauth2Login using github.
1. Create a GitHub App and get the Client ID and Client Secret values. (Specify callback URL as http://localhost:8080/login/oauth2/code/github for development, uncheck Web hooks)
2. Add those values in application.yml
3. Run the Spring Boot App.
### Creating books data in Cassandra cluster:
* First we create books data in datastax Cassandra cluster using [betterread-data-loader](https://github.com/njha-collab/betterread-data-loader) app.
* We get data dump from https://openlibrary.org/data. checkout openlibrary developers support page - https://openlibrary.org/developers
* And then process dump file and create authors data and books data in Cassandra cluster.
**Cassandra console after data creation:**
Checkout the [Book.java Class](https://github.com/njha-collab/betterreads/blob/master/src/main/java/com/njha/betterreads/book/Book.java) for **book_by_id** table which facilitates this feature.
### Book detail:
We get book by id from Cassandra book_by_id table and display it to UI
### Book search:
We make call to https://openlibrary.org/search.json?q={query} api to get search result. We can't perform search in Cassandra as that would be very slow. Ideally we should have used an Apache Lucene based text search engine (such as elastic-search or solr). We should have build an index in elastic-search from Cassandra (or Kafka depending on how we design it) and then we should have performed the search query on elastic-search. However, since the scope of this app was to learn how to use Cassandra db, we are leveraging openlibrary's available search API - https://openlibrary.org/dev/docs/api/search.
### Tracking user interactions with books:
**Cassandra console:** For every user interaction with a new book, a new row will be added in this table
1. user njha-collab adds info for book OL10005006W
2. user njha-collab updates info for book OL10005006W (same entry is updated)
3. user njha-collab adds info for another book OL10009701W
Checkout the [BookInfoByUserIdAndBookId.java Class](https://github.com/njha-collab/betterreads/blob/master/src/main/java/com/njha/betterreads/userbook/BookInfoByUserIdAndBookId.java) For **book_by_userid_and_bookid** table which facilitates this feature.
**UI:**
### My books feature:
Displays top books that a user has interacted with on user's home page
**Cassandra console:**
Checkout the [BookInfoByUserId.java Class](https://github.com/njha-collab/betterreads/blob/master/src/main/java/com/njha/betterreads/userallbooks/BookInfoByUserId.java) For **books_by_userid** table which facilitates this feature.
**UI:**
## Reading materials:
* https://www.baeldung.com/spring-data-cassandra-tutorial
* https://medium.com/@aamine/spring-data-for-cassandra-a-complete-example-3c6f7f39fef9
* https://stackoverflow.com/questions/24949676/difference-between-partition-key-composite-key-and-clustering-key-in-cassandra
* https://www.quora.com/What-is-the-difference-between-primary-partition-and-clustering-key-in-Cassandra
* https://community.datastax.com/questions/6171/primary-key-vs-clustering-column-vs-partition-key.html
* https://intellidzine.blogspot.com/2014/01/cassandra-data-modelling-primary-keys.html