Skip to content

Commit d34633e

Browse files
committed
Update the readme to reflect being able to create posts
- updated the readme to show users can now create posts by adding the posts route and checked off the create posts milestone. - updated one of the milestone's regarding user replies for better clarity
1 parent 26c5d81 commit d34633e

1 file changed

Lines changed: 27 additions & 16 deletions

File tree

readme.md

Lines changed: 27 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
- [x] Users can signup and create accounts
88
- [x] Users can login
99
- [x] Jwt auth is implemented
10-
- [ ] Users can create posts
11-
- [ ] Users can reply to posts
10+
- [x] Users can create posts
11+
- [ ] Users can reply to each other's posts
1212
- [ ] Users can delete their posts.
1313
- [ ] Users can edit their posts.
1414
- [ ] Secure all user post routes with JWT auth.
@@ -66,31 +66,42 @@
6666

6767
### Homepage
6868

69-
The homepage is the welcome page that contains a welcome message and links to the signup and login page.
69+
The homepage is the welcome page for the site that links to the signup and login page.
7070
The route is located at `Get localhost:8080/`.
7171

7272

7373
### SignUp
7474

75-
The signup page is where you fill out a form to create an account.
75+
The signup page is where you fill out a form to create an account.
7676
Its route method is `GET localhost:8080/signup`. If account creation fails the errors will be listed
7777
in json format. On success the account is created in the database and your logged into the posts page.
7878

79-
### View
8079

81-
Once the user fills out the the loginForm and clicks submit
82-
a post route with that form data `POST localhost:8080/view`
83-
creates the user's account. If there is any error with any of the fields
84-
the fields and their errors are returned in json format.
80+
### View
8581

86-
### LoginForm
82+
After submitting an account for creation from the signup route a
83+
http request to `Post localhost:8080/view` creates the account on the database.
84+
After successfully creating their account, the user automatically logged in
85+
and is redirected to their posts route.
8786

88-
The loginForm is a form page where users login; the request is at `GET` `localhost:8080/loginForm`.
89-
Once submitted, its authenticated at post route `Post` `localhost:8080/view`.
87+
### Login
9088

89+
Where the user logs in; the request is at `GET` `localhost:8080/login`.
90+
Once submitted, its authenticated at post route `Post` `localhost:8080/posts`.
9191

92-
### Posts wip
9392

94-
The Post page using the route `POST localhost:8080/posts` given the login form data
95-
authenticates the user's credentials. The Posts page is the where the users can view
96-
and modify their posts. This page is still a work in progress.
93+
### Posts
94+
95+
After login, the user will have access to their Posts page which is their homepage.
96+
The route is located at `localhost:8080/posts`. The Posts page is the where the users
97+
can view and submit posts. New posts are submitted via `POST localhost:8080`.
98+
Each Post contains the user's username, the date the post was submitted, and
99+
the post's body. The max size of the post's body is 350 characters.
100+
101+
#### Current Progress
102+
103+
As for what can be done with posts, currently the user
104+
can only submit new posts to themselves, not replies to other users.
105+
Posts also, can't be edited or deleted. Being able to make replies
106+
and delete or edit your posts are wips.
107+

0 commit comments

Comments
 (0)