https://github.com/deven96/touchcore

Careers touchcore test2
https://github.com/deven96/touchcore

Last synced: about 1 month ago
JSON representation

Careers touchcore test2

• Host: GitHub
• URL: https://github.com/deven96/touchcore
• Owner: deven96
• Created: 2019-12-24T15:13:47.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T03:21:05.000Z (almost 2 years ago)
• Last Synced: 2024-10-02T07:54:50.154Z (about 2 months ago)
• Language: JavaScript
• Size: 2.63 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Touchcore Backend Engineer Test2

Backend Test 2 written using Django

[![Python Django](https://img.shields.io/badge/Python-Django-blue.svg)](https://www.djangoproject.com/)

[![Build Status](https://travis-ci.org/deven96/touchcore.svg?branch=master)](https://travis-ci.org/deven96/touchcore)

[![Heroku App Status](http://heroku-shields.herokuapp.com/tchcore)](https://tchcore.herokuapp.com)

## Getting Started

To get this project functional locally follow the steps

- Install Python 3.6 above

- Install Git

- Clone the repo and change into directory

 

 ``` bash

    # use this command on cmd or terminal

    git clone https://github.com/deven96/touchcore.git

    # change into directory

    cd touchcore/

 ```

- Install requirements

```bash

  pip install -r requirements.txt

```

- Run migrations

```bash

  # migrate

  python manage.py migrate

```

- Run the server on default port 8000

```bash

  # runserver

  python manage.py runserver

```

## Admin Panel

- Proceed to http://localhost:8000/admin

- Login using superuser details i.e the one previously filled

## REST API

- Swagger UI for accessing the API endpoints is located at http://localhost:8000/docs

- Companies can only be viewed and not edited. Editing only occurs from the Admin Panel

## Deployed Version

A version of this code is passed through travis and tested then automatically deployed to

https://tchcore.herokuapp.com

The adminpanel login details are as specified in TEST 2 requirements

## Example view

Adding a company from the Admin Panel

![Company view](examples/touchcore-company-example.png)

REST API

![REST](examples/touchcore-employees-api.png)