add planning to README
This commit is contained in:
31
README.md
31
README.md
@@ -1,24 +1,19 @@
|
||||
# README
|
||||
|
||||
This README would normally document whatever steps are necessary to get the
|
||||
application up and running.
|
||||
## Planning
|
||||
|
||||
Things you may want to cover:
|
||||
### Question for the Product Manager
|
||||
- We will allow user to use @mentioning only in the beginning of text?
|
||||
- What do you think about create an extensive architecture to support new features, creating a relation of posts and users through Mention entity?
|
||||
|
||||
* Ruby version
|
||||
### Implementation
|
||||
1. Improve Post entity scopes, moving `post`, `repost`, `quoted_post` and `reply` to `kind enum column`, becase of the static characteristic of posts a precomputed status will be perfect to simplify queries.
|
||||
2. Rename `Post#quoted_post` to `Post#reference`
|
||||
3. Add a reply route to post, example `POST /posts/1/replys`, when creating a reply save post with kind
|
||||
4. When quering a `reply`, the frontend will concat orignal post owner username with post content
|
||||
|
||||
* System dependencies
|
||||
## Self-critique and scaling
|
||||
|
||||
* Configuration
|
||||
|
||||
* Database creation
|
||||
|
||||
* Database initialization
|
||||
|
||||
* How to run the test suite
|
||||
|
||||
* Services (job queues, cache servers, search engines, etc.)
|
||||
|
||||
* Deployment instructions
|
||||
|
||||
* ...
|
||||
-
|
||||
-
|
||||
-
|
||||
Reference in New Issue
Block a user