mrouhi13 / djecrety Goto Github PK

Use SVG for Logos
Use SVG file for Github logo and Djecrety logo.

Set Domain
Set "djecrety.ir" DNS records to Github Pages.

Add Github Repo Link
Add Github repository link to the index.html

Update Readme
Update readme for using and contributing the package.

Add Policy Link
Add policy link in the footer with a message like below:

Djecrety is written using pure Javascript, CSS, and HTML and do not have any back-end code and database.

SEO Optimization
Consider the SEO suggestions from the https://gtmetrix.com

Develop Djecrety Django Package

• Implement a function that updates settings.py file with the new secret key
• Implement a function that generates a new secret key
• Implement a command class that updates secret key with specifying settings directory
• Write unit tests for the generator function
• Write unit tests for updater function
• Write unit tests for djecrety command

Create Github Repo
Add the project to Github.

• .gitignore file
• README.md file
• LICENSE file

Build Package
Setup the python package.

Add Google Analytics
Add Google Analytics script to the site.

I would recommend putting the secret key inside an .env file that would store all secrets (including admin and database password) and from settings.pygetting the secret key like this. Then we can gitignore the .envfile.

settings.py

import os

# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = os.environ.get(
    "DJANGO_SECRET_KEY"
)

.env

DATABASE_NAME=**********
DATABASE_USER=**********
DATABASE_PASSWORD=**********
...

DJANGO_SECRET_KEY={SECRET_KEY}

...

I think this method helps preventing mistakes while facilitating collaboration as there are many things we can change inside settings.pythat we would want other developpers to pull.

The current recommendation:

So recommended: Keep it safe. Ignore
settings.py file in your commits. Change the secret
key on your deploy. If you lost the secret key for any reason or
the server got compromised change it as soon as possible.

Refactor Index Page
Refactor index.html tags and styles.

Site Optimization
Make the site SEO in friendly way.

• Add essential meta tags
• Add robots.txt file
• Add sitemap.xml file
• Add favicon
• Optimize images
• Minify assets

Update Logo
Update logo and logo type.

Add Twitter Link
Add a Twitter link next to the email button.

Update Index Page
Add package reference and help to the index page.

Design Index Page
Design index.html page using Semantic UI and jQuery.

Brand Icon Issue
Fix Twitter icon issue.

Clipboard Issue
When clicking on the generate button, clipboard doesn't change.

Set Logo
Add logo and favicon.

Add Dark Mode Switch
Add a switch for changing theme mode (Dark/Light).

Upload to PIP
Upload package to PIP.

Travis CI
Add .travis.yml file and check with Travis service for CI.

Hello!

First of all, I really love to use your website - it is simple but amazing because I need to create keys so often and your work just makes it so much easier.

Just one request:
Please remove it that sometimes #-characters can show up in the key since python will interpret the rest as a comment.

Thank you very much!