newtonkiragu / asset-manager

A web application in Django that allows a company admin to see which employee has which assets e.g company laptop, hard disk, books etc.

Asset Manager

Description

A web application in Django that allows a company admin to see which employee has which assets e.g company laptop, hard disk, books etc.

Link to deployed site

// to do

Table of content

1. Description
2. BDD
3. Setup and installations
4. Deployment
5. Bugs
6. Contact me
7. Licensing

bdd

Behavior	Route	Request
ToDo

Setup and installations

Prerequisites

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

Technologies used

- Python 3.6
- HTML
- Bootstrap 4
- Heroku
- Postgresql
- Django, Django Rest Framework

Clone the Repo and checkout into the project folder.

git clone [e-mail]:newtonkiragu/asset-manager.git && cd asset-manager

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:

SECRET_KEY='<Secret_key>'
NAME='asset_manager'
USER='<Username>'
PASSWORD='<password>'
HOST='localhost'
MODE='dev'
DEBUG=True
DISABLE_COLLECTSTATIC=1
EMAIL='<main-company-email>'
EMAIL_PASSWORD='<main-company-email-password>'

Install dependancies

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

Create the Database

In a new terminal, open the postgresql shell with psql.

CREATE DATABASE asset_manager;

Make and run migrations

python3.6 manage.py makemigrations && python3.6 manage.py migrate

Run the app

python3.6 manage.py runserver

Open localhost:8000

Deployment

// to do

Bugs

Create an issue mentioning the bug you have found

Known bugs

• none yet

Support and contact details

Contact Newton Karanu for further help/support

License

MIT

Copyright (c)2019 Newton Karanu