SpaceyaTech / mastori

Mastori is a community-driven open-source project that aims to provide a simple and efficient blogging platform built for the Dev Community
https://www.spaceyatech.com/
22 stars 54 forks source link

hide environment variables #92

Closed raykipkorir closed 1 year ago

raykipkorir commented 1 year ago

Description

I have hidden the environment variables inside .env file. Solving issue #65 It's a good practice to hide sensitive information from the public. I have read through the comments on this issue #65, in my opinion using python-decouple is the better way to go as it's easy to setup.

Dependecies \ colorama==0.4.6 dj-database-url==1.2.0 python-decouple==3.7

Fixes # (issue) Fixing issue #65

Type of change

Please delete options that are not relevant.

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Test Configuration:

Checklist:

sangkips commented 1 year ago

Can we try to reduce the dependencies for now, it's good to have environment variables in a .env file but make it to be easy for someone using this code understand what you are doing.

wanjirumurira commented 1 year ago

The .env file will be available locally.We need to find a way to ensure that any change or update to this file will be synchronized within the team.

raykipkorir commented 1 year ago

The .env file will be available locally.We need to find a way to ensure that any change or update to this file will be synchronized within the team.

I have added a .env.example file that's pushed to this repo so if anyone adds an environment variable while developing he/she will also have to make the changes in this .env.example file so that every member of the team can know what environment variables to set while in development. .env.example file does NOT contain any sensitive data. It's just a blueprint of our .env file

raykipkorir commented 1 year ago

For the GitHub actions check runs to be successful. We have to set environment variables for this repo. Use .env.example as the blueprint to create the environment variables. DEBUG and DATABASE_URL have their default values, although for the database our default is sqlite3 which has not pushed so we have to set up a db. We can create a free database instance using ElephantSQL or any other service. Generate secret_key 👇 then set it as value to SECRET_KEY from django.core.management.utils import get_random_secret_key print(get_random_secret_key())

JimmyTron commented 1 year ago

For the GitHub actions check runs to be successful. We have to set environment variables for this repo. Use .env.example as the blueprint to create the environment variables. DEBUG and DATABASE_URL have their default values, although for the database our default is sqlite3 which has not pushed so we have to set up a db. We can create a free database instance using ElephantSQL or any other service. Generate secret_key point_down then set it as value to SECRET_KEY from django.core.management.utils import get_random_secret_key print(get_random_secret_key())

I will do the review on the variables