paulndambo / asett-type-e-submission

Django Assessment

0. Prequisites

1. Download and Install Python from https://www.python.org/downloads/

2. To run the project, if you have downloaded it to you computer, the compand is;- python manage.py runserver or python3 manage.py runserver

3. When the server is running, access the site here: http://127.0.0.1:8000

4. Password Reset email can be found here https://mailtrap.io/inboxes/2393953/messages

   Password: [email protected]
   Email: [email protected]
   

5. To run tests, the command is: pytest -s -v

1. How to get code and get started locally

1. clone the project from github using git, if you don't have git installed on your computer,\n Download it here https://git-scm.com/ Follow a few steps to install and get started, you can follow this guide https://github.com/git-guides/install-git After setting up git, open the command prompt/terminal on your computer and type the following commands(after every command press enter);-

   i. cd Desktop
   ii. mkdir DjangoAssessment
   iii. cd DjangoAssessment
   iv. python -m venv assessmentenv
   v. source assessmentenv/bin/activate
   vi. git clone https://github.com/Paulndambo/ASETT-Type-E-Submission.git
   vii. cd ASETT-Type-E-Submission
   viii. pip install -r requirements.txt
   

   Note: The above instructions will work 100% on linux and mac computers, for windows you mignt need to check some things.

2. If you don't want to install git on your laptop, click this link and download a zip file of the project into your computer https://github.com/Paulndambo/ASETT-Type-E-Submission.git

3. You can also use the github desktop application, download it here, https://desktop.github.com/, download it and follow the prompt steps to get started.

   Note: After step 2 and 3 follow the steps on step 1.

2. Note, If you just want to run the project and test the interface

1. On Docker, run the following command (assuming you have docker installed) docker run -p 8000:8000 40781998/django-crypto-app-assessment:latest
2. Kubernetes, if you have access to a kubernetes cluster Follow the steps listed on step 1 of (How to get code and get started locally), Then run the following command kubectl apply -f k8s/

How to run tests, (this assumes you have downloaded the repository on to your laptop)

Run this command pytest -s -v