(DOCS): Began specifications for user authentication.
This includes API and UI specs. The next step is actually beginning to write some API code.
This commit is contained in:
parent
d1a1a2714e
commit
e1b9d9718e
@ -213,6 +213,58 @@ creation process will take place here
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Authentication
|
||||||
|
|
||||||
|
This section outlines the authentication requirements for the application. This section
|
||||||
|
is **not** broken down by page, they are simple defined.
|
||||||
|
|
||||||
|
#### Pages
|
||||||
|
|
||||||
|
- [ ] **Register Page**
|
||||||
|
- [ ] Input form with required details: *name, email and password*
|
||||||
|
- [ ] *Password strength meter**
|
||||||
|
- [ ] User should be directed to the home page when account is created
|
||||||
|
- [ ] User will be logged in
|
||||||
|
- [ ] A notification will be provided to the user indicating success and redirection
|
||||||
|
- [ ] User should see error messages when validation issues occur
|
||||||
|
- [ ] Email already in use
|
||||||
|
- [ ] Passwords do not match
|
||||||
|
- [ ] Server failure (this should never happen)
|
||||||
|
|
||||||
|
- [ ] **Sign In Page**
|
||||||
|
- [ ] Input form with required details: *email, password and forgot password button*
|
||||||
|
- [ ] User should be directed to the home page after signing in
|
||||||
|
- [ ] A notification will be provided to the user indicating success and redirection
|
||||||
|
- [ ] User should see error messages when validation issues occur
|
||||||
|
- [ ] Invalid password
|
||||||
|
- [ ] Server failure (this should never happen)
|
||||||
|
|
||||||
|
'*': Future ideas
|
||||||
|
|
||||||
|
|
||||||
|
#### API Requirements
|
||||||
|
|
||||||
|
- [ ] **Register Page**
|
||||||
|
- [ ] Create a new user in the database
|
||||||
|
- [ ] Password should be stored in the database as a hash
|
||||||
|
- [ ] Ensure that emails are not duplicated
|
||||||
|
- [ ] "Log user in" when account is created
|
||||||
|
- [ ] User should be redirected to the home page on success
|
||||||
|
|
||||||
|
- [ ] **Sign In Page**
|
||||||
|
- [ ] Sign user in and return data to be stored in the session
|
||||||
|
- [ ] Validate password to the hash stored in the DB
|
||||||
|
- [ ] User should be redirected to the home page on success
|
||||||
|
|
||||||
|
- [ ] **Session Management**
|
||||||
|
- [ ] *Uses cookies to store required data**
|
||||||
|
|
||||||
|
'*': Unsure on technical implementation
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Database Requirements
|
## Database Requirements
|
||||||
|
|
||||||
This section outlines the specific technical requirements for the database store for
|
This section outlines the specific technical requirements for the database store for
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user