https://github.com/somethingmorerelevant/experment-thirty3

https://github.com/somethingmorerelevant/experment-thirty3

Last synced: over 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/somethingmorerelevant/experment-thirty3
• Owner: somethingmorerelevant
• Created: 2022-02-02T05:27:24.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-03-02T10:02:23.000Z (over 3 years ago)
• Last Synced: 2025-01-09T08:46:34.666Z (over 1 year ago)
• Language: Python
• Size: 43 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

          

## Code Quality

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)

## Dependencies

![Django](https://img.shields.io/badge/django-%23092E20.svg?style=for-the-badge&logo=django&logoColor=white)

![DjangoREST](https://img.shields.io/badge/DJANGO-REST-ff1709?style=for-the-badge&logo=django&logoColor=white&color=ff1709&labelColor=gray)

![JWT](https://img.shields.io/badge/JWT-black?style=for-the-badge&logo=JSON%20web%20tokens)

# credx

A Django project built using [n0tNoah/django-cookiecutter-rest](https://github.com/n0tNoah/django-cookiecutter-rest)

## Dev-Setup

```bash

pip install pre-commit

git init

```

## Installation

```bash

git clone https://github.com/n0tNoah/django-cookiecutter-rest

pip install -r requirements.txt

python3 manage.py migrate

#optional to start contributing

pip install pre-commit

pre-commit install

```

## running locally

```bash

python3 manage.py runserver

```

## License

**MIT**

## Actions & Workflows

#### New PR Create for (`master`/`main`) branch:

     Steps:

        - Check package dependency/vulnerability issues

        - Run Code Analysis (run pre-commit hooks on checkout )

        - Run Test Cases

    Outcomes:

        PASS: Reviewer Should Reject PR and ask dev to fix the issues

        FAIL: Merge PR

#### Push/PR Merge in (`master`/`main`) branch:

     Steps:

        - Check package dependency/vulnerability issues

        - Run Code Analysis (run pre-commit hooks on checkout )

        - Run Test Cases

    Outcomes:

        PASS: Trigger Schematic Versioning Tag release (automatic)

        FAIL: NA

#### New Release Create:

     Steps:

        - Checkout Release tag and build container image

        - Run Code Analysis (run pre-commit hooks on checkout)

        - Run Test Cases

        - Perform CodeCov Report

        - Perform Sonar-Cube Scan

        - Push Container image to ECR/Docker Hub

    Outcomes:

        PASS: Trigger image build and push to container registery (automatic)

        FAIL: NA

#### Manual Workflow on specific branch:

     Steps:

        - Checkout Branch

        - Check Package dependency/vulnerability issues

        - Run Code Analysis (run pre-commit hooks on checkout)

        - Run Test Cases

        - Perform CodeCov Report

        - Perform Sonar-Cube Scan

    Outcomes:

        PASS: NA

        FAIL: NA