django_template

DRF Template

This repository works as a base project to easily start an API with Django REST

You can use it locally, or with docker, or deploy it directly to your project on Heroku

How to Use

• Create your own copy of the repository clicking on Use this template button, name it and clicking on Create repository from template

• Since you have created your own project, clone it and enter your project file

• Go to your main folder and run your project with your preferred method

There are 3 methods to use your new project

NOTE: You can use openssl rand -base64 32 command in you terminal to generate a django secret key

Run your project locally

You must have already installed an configured your potgresql database

• Execute pip install -r requirements.txt

• Uncomment the DEBUG = False constant in settings

• Uncomment too the DATABASES dict below ### FOR RUN LOCALLY #### section and set the values with the respective data in settings

• Execute following commands:

python manage.py makemigrations

python manage.py migrate

python manage.py runserver 0.0.0.0:8000

Open your favorite browser and go to:

http://0.0.0.0:8000

Run your project using Docker

• Create a copy of the .env.example file and use it as a guide to fill it with the respective information:

cp .env.example .env

• Open your settings.py and uncomment the # DEBUG = os.getenv('DEBUG') line

• Uncomment too the DATABASES dict below #### FOR RUN WITH DOCKER #### section

• Execute the docker compose command to build project and run your project:

sudo docker-compose up -d --build

Open your favorite browser and go to:

http://0.0.0.0:8000

Load your project to Heroku

• Uncomment the DEBUG = False constant in settings

• Uncomment the DATABASES dict below #### FOR DEPLOY ON HEROKU #### section in settings

• Execute following commands to build migrations locally:

python manage.py makemigrations

python manage.py migrate

python manage.py runserver 0.0.0.0:8000

• Push your local changes to your git repository:

git add .

git commit -m "First Commit"

git push origin master

• Install Heroku CLI: sudo snap install --classic heroku

• Login in Heroku heroku login

• If you haven't a Heroku App, create one Don't use underscores:

heroku create yourappname

• Sync your git repo with your heroku app:

heroku git:remote -a yourappname

• Create the heroku database postgres for the app:

heroku addons:create heroku-postgresql:hobby-dev

• Push your project to your Heroku App: git push heroku master

• Execute the migrations in your remote app:

heroku run python manage.py migrate

• Open your remote project:

heroku open

By @DDBCDVD

If you find bugs, or do you want me to addsome other host to deploy the project:

Contact Me

• logos.softech@gmail.com
• LinkedIn
• Twitter
• Telegram DDBCDVD
• Telegram LogoSSoftech