nebkor
/
what2watch
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme

This commit is contained in:
Joe Ardent 2023-06-22 16:39:41 -07:00
parent 84d70336d3
commit 0bcd508577
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -1,11 +1,11 @@
# *Untitled Social Media Consumption Project* # *Untitled Project for the Social Consumption of Media*
*(last updated 2023-06-11)* *(last updated 2023-06-22)*
![watchy the watch-witch](witch_watch_scary_logo.png) ![watchy the witch-tv](witch_watch_scary_logo.png)
This is the main repository for USMCP, formerly "Witch Watch", formerly "What2.Watch", This is the main repository for UPSCM, formerly "Witch Watch", formerly "What2.Watch",
etc. etc. USMCP is intended to primarily support the following things as an end user: etc. etc. UPSCM is intended to primarily support the following things as an end user:
* keep track of things you want to watch, eg, TV shows, movies, videos, etc. * keep track of things you want to watch, eg, TV shows, movies, videos, etc.
* including type of thing, whether or not it's private, whether you watched it already, etc. * including type of thing, whether or not it's private, whether you watched it already, etc.
* keep track of people you want to watch those things with * keep track of people you want to watch those things with
@ -32,7 +32,7 @@ As a developer, it's meant to be easy to work on:
### Rust ### Rust
Like most Rust projects, it's broken up into at least two distinct crates, a [`bin`](src/main.rs) crate that acts as Like most Rust projects, it's broken up into at least two distinct crates, a [`bin`](src/main.rs) crate that acts as
a thin veneer over and runner for the main entry point inside the [`lib`](src/lib.rs) crate. The lib a thin veneer over and runner for application, defined inside a [`lib`](src/lib.rs) crate. The lib
crate exposes a couple public functions and datastructures used in the bin crate and in testing, but crate exposes a couple public functions and datastructures used in the bin crate and in testing, but
otherwise mostly brings some lib-crate-wide types into the `crate::` scope and defines the `app` otherwise mostly brings some lib-crate-wide types into the `crate::` scope and defines the `app`
method that returns an [Axum::Router](https://docs.rs/axum/latest/axum/struct.Router.html), and method that returns an [Axum::Router](https://docs.rs/axum/latest/axum/struct.Router.html), and
@ -91,7 +91,7 @@ At the project root, next to the `src/` directory, are two other directories:
* `migrations/`: SQL files that define the schemas and add things like indexs and triggers * `migrations/`: SQL files that define the schemas and add things like indexs and triggers
* `templates/`: HTML templates used by one or more Askama templates to control presentation * `templates/`: HTML templates used by one or more Askama templates to control presentation
It's likely that there will be `css/` and `javascript` directories in the future. Likewise code for It's likely that there will be `css/` and `javascript/` directories in the future. Likewise code for
helping with deploying or monitoring. helping with deploying or monitoring.
## Development goals ## Development goals
@ -102,9 +102,9 @@ outlined at the top are working. The front end is approximately unstarted.
The current development priorities are, in order from most to least important, The current development priorities are, in order from most to least important,
* finishing the `watches` module, allowing adding things to watch to the system and to your own watchlist * finishing the `watches` module, allowing adding things to watch to the system and to your own watchlist
* more front-end templates to support the `watches` operations
* full-text-search with Tantivy * full-text-search with Tantivy
* realistically, you need this as soon as you can start adding data to it * realistically, you need this as soon as you can start adding data to it
* endpoints for inviting friends to watch stuff with you
After that, it will be a focus on the front end, and possibly a Flutter/Dart app for mobile. For the After that, it will be a focus on the front end, and possibly a Flutter/Dart app for mobile. For the
web client, I'm leaning toward something like [HTMx](https://htmx.org/docs/#introduction) but am not web client, I'm leaning toward something like [HTMx](https://htmx.org/docs/#introduction) but am not