cz3002-backend's Introduction

cz3002-backend

default Swagger API document address: root address: eg http://localhost:8000

install guide

install dependency

You can use pip to install all package yourself, the dependency list in pipfile, just ignore below

// install pipenv
$ pip install pipenv

//install dependency
$ pipenv install

database migration

$ python manage.py makemigrations
$ python manage.py migrate

run server

//to start environement in console
$ pipenv shell

// run server
python manage.py runserver

//with port
python manage.py runserver 8080

for email you can change email addr and pasword in settings, or use .env below

create a .env file under cz_3002_backend, not the folder contain pipfile
add 2 line in it
- export EMAIL_HOST_USER=your_emal
- export EMAIL_HOST_PASSWORD=password //in terminal //in terminal

$ source .env

doc

Add following to your http header after login

Authorization: Bearer [access token]

access token expire after 5 minutes and require to use fresh to get new access toen

All the endpoint require access token except following:

register
verify email
login
password reset email
password reset token check
change new password

cz3002-backend's People

Contributors

Watchers

cz3002-backend's Issues

forget password

When user enter wrong password one or multiple times, user use reset password function

User clicks forget password in the login page
Users enter email address
User selects ‘request password reset’.
Once email account is authenticated, email server sends email to reset password
User opens email, and follows process to reset password
User is now able to log in with new password

User enters incorrect email
System shows “This email does not exist”
User re-types his/her email address
If user is still unable to enter the correct email after multiple attempts, the application will request the user to personally
contact a helpline
Continue step 3 in normal flow