| @@ -1,3 +1,6 @@ | |||||
| # WorkX Week 1 | |||||
| Helpful Links: [Deliverables](https://docs.google.com/spreadsheets/d/11FLRwgf3WVm9d-iV3utATLFd_O2Ov5y0VAbVyr4K5dQ/edit) | |||||
| ## Project Setup | ## Project Setup | ||||
| 1. Clone the app | 1. Clone the app | ||||
| 2. Create a virtual environment `python3 -m venv virtualenv` | 2. Create a virtual environment `python3 -m venv virtualenv` | ||||
| @@ -7,7 +10,7 @@ | |||||
| 6. Post migration run `python manage.py createsuperuser` to create a user with Email ID and password of your choice | 6. Post migration run `python manage.py createsuperuser` to create a user with Email ID and password of your choice | ||||
| 7. Execute `python manage.py runserver` | 7. Execute `python manage.py runserver` | ||||
| ## API integration for the front-end | |||||
| ## Auth API integration for the front-end | |||||
| 1. Pass Email ID `{"email" : "<registered user email id>"}` as a POST request to http://localhost:8000/auth/email/ | 1. Pass Email ID `{"email" : "<registered user email id>"}` as a POST request to http://localhost:8000/auth/email/ | ||||
| 2. Since the backend will be locally connected to check the OTP visit the console on which you're running the backend. The OTP/Token will be displayed along with the appropriate message. | 2. Since the backend will be locally connected to check the OTP visit the console on which you're running the backend. The OTP/Token will be displayed along with the appropriate message. | ||||
| 3. Pass the OTP as POST request to http://localhost:8000/auth/token/ `{"email" : "<registered user email id>", "token": "<received OTP>"}` | 3. Pass the OTP as POST request to http://localhost:8000/auth/token/ `{"email" : "<registered user email id>", "token": "<received OTP>"}` | ||||