mirror of
				https://github.com/krislamo/DJ-BaseSite
				synced 2025-10-31 18:18:33 +00:00 
			
		
		
		
	Updated README for readability
This commit is contained in:
		
							
								
								
									
										34
									
								
								README
									
									
									
									
									
								
							
							
						
						
									
										34
									
								
								README
									
									
									
									
									
								
							| @@ -1,7 +1,7 @@ | |||||||
| DJ-BaseSite was written in Python 2.7 and Django 1.4 | DJ-BaseSite was written in Python 2.7 and Django 1.4 | ||||||
|  |  | ||||||
| Description: | Description: | ||||||
| DJ-BaseSite (or Django-BaseSite) is a customizable login and register system with required email activation. While most people just use django-registration, I decided to write my own to learn more about Django.  | DJ-BaseSite is a customizable login and register system with required email activation. While most people just use django-registration, I decided to write my own to learn more about Django.  | ||||||
|  |  | ||||||
| NOTE TO DEVS: | NOTE TO DEVS: | ||||||
| A deactivation system hasn't been added. The login system needs to check attempts and display a CAPTCHA after a certain amount, this isn't included either. It also doesn't have an account recovery option. I plan to implement all of these things in future updates. | A deactivation system hasn't been added. The login system needs to check attempts and display a CAPTCHA after a certain amount, this isn't included either. It also doesn't have an account recovery option. I plan to implement all of these things in future updates. | ||||||
| @@ -19,13 +19,31 @@ Instructions | |||||||
| DJ-BaseSite uses Recaptcha to prevent bots from creating accounts, so you'll need to get private and public keys from the website: http://www.google.com/recaptcha | DJ-BaseSite uses Recaptcha to prevent bots from creating accounts, so you'll need to get private and public keys from the website: http://www.google.com/recaptcha | ||||||
|  |  | ||||||
| Configuration Variable Meanings. | Configuration Variable Meanings. | ||||||
|  | =================================== | ||||||
|  | -baseurl | ||||||
|  | It is used to create activation and deactivation links [in views.py in register_user()] | ||||||
|  |  | ||||||
|  | -admin_name/email | ||||||
|  | Adds a name and email to the ADMINS tuple in settings.py | ||||||
|  | http://docs.djangoproject.com/en/dev/ref/settings/#admins | ||||||
|  |  | ||||||
|  | -secret_key | ||||||
|  | A string used to provide cryptographic signing. (don't use spaces due to the configurtion system) | ||||||
|  | https://docs.djangoproject.com/en/dev/ref/settings/#secret-key | ||||||
|  | http://www.random.org/passwords/?mode=advanced | ||||||
|  |  | ||||||
|  | -captcha_publickey/privatekey | ||||||
|  | DJ-BaseSite uses Recaptcha to prevent bots from creating accounts, get keys at http://www.google.com/recaptcha | ||||||
|  |  | ||||||
|  | -HOSTsmpt | ||||||
|  | The SMPT server address with the email used to send activation emails. If your email doesn't support SMPT I highly suggest GMAIL. | ||||||
|  |  | ||||||
|  | -HOSTemail | ||||||
|  | The email address | ||||||
|  |  | ||||||
|  | -HOSTpass | ||||||
|  | The email's password | ||||||
|  | =================================== | ||||||
|  |  | ||||||
| baseurl - It is used to create activation and deactivation links ( in views.py in register_user() ) |  | ||||||
| admin_name/email - adds a name and email to the ADMINS tuple in settings.py ( http://docs.djangoproject.com/en/dev/ref/settings/#admins ) |  | ||||||
| secret_key - A secret randomly generated string of characters (don't use spaces) ( http://www.random.org/passwords/?mode=advanced ) |  | ||||||
| captcha_publickey/privatekey - DJ-BaseSite uses Recaptcha to prevent bots from creating accounts, get keys at google.com/recaptcha |  | ||||||
| HOSTsmpt - The SMPT server address with the email used to send activation emails. If your email doesn't support SMPT I highly suggest GMAIL. |  | ||||||
| HOSTemail - The email address |  | ||||||
| HOSTpass - The email's password |  | ||||||
|  |  | ||||||
| NOTE: It creates a development project, DEBUG is set to True in the settings.py so it is in no condition for deployment. | NOTE: It creates a development project, DEBUG is set to True in the settings.py so it is in no condition for deployment. | ||||||
		Reference in New Issue
	
	Block a user