newtonkiragu / 8teq-user

user management system for 8teq

8teq User Management System

Description

A user management system with the following functionalities

• User registration
• Login
• View user details
• Change password
• Logout

Link to deployed site

To be deployed

Table of content

1. Description
2. API endpoints
3. Setup and installations
4. Deployment
5. Contributing
6. Bugs
7. Contact me
8. Licensing

endpoints

API Endpoint	Description	Request
http://127.0.0.1:8000/api/signup	Create a new user account	POST
http://127.0.0.1:8000/api/api-auth/login/	Login a user	POST
http://127.0.0.1:8000/api/user/id	View details of the new user account	GET
http://127.0.0.1:8000/api/change_password/int:pk/	Reset password of a specific user	GET
http://127.0.0.1:8000/api/change_password/int:pk/	Complete resetting password of a user	PUT
http://127.0.0.1:8000/api/api-auth/login/logout	Logout a specific user	DELETE

Setup and installations

Prerequisites

1. Python3.6
2. virtualenv
3. Pip
4. Django
5. Django Rest Framework

Technologies used

- Python 3.6
- Django, Django Rest Framework

Clone the Repo and checkout into the project folder.

git clone [e-mail]:newtonkiragu/8teq-user.git && cd 8teq-user

Create and activate the virtual environment

python3.6 -m virtualenv virtual

source virtual/bin/activate

Setting up environment variables

Create a .env file and paste paste the following filling where appropriate:

MODE='dev'
DEBUG=True
DISABLE_COLLECTSTATIC=1

Install dependancies

Install dependancies that will create an environment for the app to run pip install -r requirements.txt

Run migrations

python3.6 manage.py migrate

Run the app

python3.6 manage.py runserver

Open localhost:8000

Deployment

To deploy the application, please follow the instructions in this gist

Contributing

Please read this comprehensive guide on how to contribute. Pull requests are welcome :-)

Bugs

Create an issue mentioning the bug you have found

Known bugs

• none yet

Feature request

Create an issue mentioning the feature you would like implemented

Support and contact details

Contact Newton Karanu for further help/support

License

MIT