Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
fauzaanu committed Aug 24, 2024
1 parent 4967a5a commit 7b37e5a
Showing 1 changed file with 19 additions and 8 deletions.
27 changes: 19 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

> Note: Both the readme and the code in the repo are a work in progress and is incomplete!
The idea of `onlydjango` is to
- Use onlydjango (obviousely)
- Make deploying Django really easy
- Make it easy to implement a task que in Django
The idea of `onlydjango` is to use as much of django until you cant.

onlydjango aims to
- Make deploying Django easy
- Already setup task ques
- Utilize Generic views along with Django Forms, while also using crispy forms
- Make it easy to style Django Templates with tailwindcss being setup initially
- Overall, this boilerplate is about additional productivity and speed for an already productive framework.
- have tailwindcss pre-setup

Overall, This boilerplate is optimized for a speedy development process based on working with Django over multiple projects in the past. Nothing that is included in this boilerplate is new. This boilerplate is also very opinionated in the way you should be building django applications. Trying to fight these opinions will not give you the best productivity this boilerplate offers.
This boilerplate is constantly being updated as I start new django projects and try to use this as the starting point. Hopefully it will reach a stage where I dont have to come back to edit this repo while setting things up.

## Generic Views

Expand All @@ -28,9 +28,20 @@ The easiest way to deploy django projects really fast is railway due to the almo

Todo: Add a dockerfile so that deployments can be possible in other platforms as well

## Databases

While I am a fan of sqlite and using sqlite for development, sqlite does not fit the purpose of this repo as we are trying to go for dev speed and deploying sqlite on a containerized way is not great for that.

There are two databases you should run:
redis and postgresql with their default settings and default ports exposed from the official docker containers.

Todo: add the commands here

## Authentication

The package `django-allauth` is used for all authentication. For a really quick setup telegram is implemented. Using ngork you can have a working dev environment for telegram authentication. It can be argued that google auth being default might be easier, but I disagree, as you can have telegram authentication working with a couple of chats with @botfather and running ngrok.
The package `django-allauth` is used for all authentication. For a really quick setup telegram is implemented. Using ngrok you can have a working dev environment for telegram authentication. It can be argued that google auth being default might be easier, but I disagree, as you can have telegram authentication working with a couple of chats with @botfather and running ngrok.

Another package we will include will be an otp based authentication package where we will add fake authentication of a preset OTP code. This can make it very easy to get a login system working right away, however allauth is also very relevant and will not be removed.

## Logging

Expand Down

0 comments on commit 7b37e5a

Please sign in to comment.