|
1 |
| -# Styleguide-Example |
2 |
| - |
3 |
| ---- |
4 |
| - |
5 |
| -## 📢 **The Django Styleguide Survey has ended. Expect results soon.** 📢 |
6 |
| - |
7 |
| -1. More about it here - <https://www.hacksoft.io/blog/django-styleguide-survey>. |
8 |
| -1. Issue where we track the feedback - <https://github.com/HackSoftware/Django-Styleguide/issues/90>. |
9 |
| - |
10 |
| ---- |
| 1 | +# Django Styleguide Example |
11 | 2 |
|
12 | 3 | **Table of contents:**
|
13 | 4 |
|
14 | 5 | <!-- toc -->
|
15 | 6 |
|
| 7 | +- [How to ask a question or propose something?](#how-to-ask-a-question-or-propose-something) |
| 8 | +- [What is this?](#what-is-this) |
| 9 | +- [Structure](#structure) |
16 | 10 | - [General API Stuff](#general-api-stuff)
|
17 | 11 | * [CORS](#cors)
|
18 | 12 | - [Authentication - JWT](#authentication---jwt)
|
|
39 | 33 |
|
40 | 34 | ---
|
41 | 35 |
|
42 |
| -This project serves as an [example of our styleguide](https://github.com/HackSoftware/Django-Styleguide) |
| 36 | +## How to ask a question or propose something? |
| 37 | + |
| 38 | +Few points to navigate yourself: |
| 39 | + |
| 40 | +1. If you have an issue with something related to the Django Styleguide Example - **just open an issue. We will respond.** |
| 41 | +1. If you have a general question or suggestion - **just open na issue. We will respond.** |
| 42 | +1. Even if you have a question that you are not sure if it's related to the Django Styleguide - **just open an issue anyway. We will respond.** |
| 43 | + |
| 44 | +That's about it ✨ |
| 45 | + |
| 46 | +## What is this? |
| 47 | + |
| 48 | +Hello 👋 |
| 49 | + |
| 50 | +This projects serves as the following: |
| 51 | + |
| 52 | +1. As an [example of our Django Styleguide](https://github.com/HackSoftware/Django-Styleguide), where people can explore actual code & not just snippets. |
| 53 | +1. As a Django project, where we can test various things & concepts. A lot of the things you see here are being used as a foundation of our internal projects at [HackSoft](https://www.hacksoft.io/). |
| 54 | + - Usually, this is how something ends up as a section in the [Django Styleguide](https://github.com/HackSoftware/Django-Styleguide) |
| 55 | +1. As a place for all code examples from [our blog](https://www.hacksoft.io/blog). |
| 56 | + - Code snippets tend to decay & **we want most of our blog articles to be up to date.** That's why we place the code here, write tests for it & guarantee a longer shelf life of the examples. |
| 57 | + |
| 58 | +If you want to learn more about the Django Styleguide, you can watch the videos below: |
| 59 | + |
| 60 | +**Radoslav Georgiev's [Django structure for scale and longevity](https://www.youtube.com/watch?v=yG3ZdxBb1oo) for the philosophy behind the styleguide:** |
| 61 | + |
| 62 | +[](https://www.youtube.com/watch?v=yG3ZdxBb1oo) |
| 63 | + |
| 64 | +**Radoslav Georgiev & Ivaylo Bachvarov's [discussion on HackCast, around the Django Styleguide](https://www.youtube.com/watch?v=9VfRaPECbpY):** |
| 65 | + |
| 66 | +[](https://www.youtube.com/watch?v=9VfRaPECbpY) |
| 67 | + |
| 68 | +## Structure |
| 69 | + |
| 70 | +The initial structure was inspired by [cookiecutter-django](https://github.com/pydanny/cookiecutter-django). |
43 | 71 |
|
44 |
| -The structure is inspired by [cookiecutter-django](https://github.com/pydanny/cookiecutter-django) and modified based on our experience with Django. |
| 72 | +**The structure now is modified based on our work & production experince with Django.** |
45 | 73 |
|
46 | 74 | Few important things:
|
47 | 75 |
|
|
0 commit comments