PR#105: Update Readme - fedora-commops/fedora-happiness-packets

fedora-commops / fedora-happiness-packets

#105 Update Readme

Closed 5 years ago by feisal. Opened 5 years ago by feisal.

Unknown source update-readme into master

update readme file

feysal-Ibrahim • 5 years ago

e68be74

removed duplicate button

feysal-Ibrahim • 5 years ago

d25f2b7

setting up dev environment

feysal-Ibrahim • 5 years ago

151c855

README.md

file modified

		`@@ -4,8 +4,16 @@`

		`# Setup`

		`+`
		`Make sure you have Docker and Docker Compose installed.`

		`+ To run this project or the tests, you need to set up a virtualenv, install the dev requirements and set the correct DJANGO_SETTINGS_MODULE, for example with:`
		`+`
		+ * `virtualenv --no-site-packages --prompt='(fedora-happiness-packets)' virtualenv/
		`+ source virtualenv/bin/activate pip`
		`+ * pip install -r requirements/dev.txt`
		+ * export DJANGO_SETTINGS_MODULE=happinesspackets.settings.dev`
		`+`
		`In order for the login and send views to work, you must supply an OpenID Connect Client ID and Client Secret:`

		`chmod +x generate_client_secrets.sh`

happinesspackets/settings/dev.py

file modified

		`@@ -49,7 +49,11 @@`
		`)`

		`SELENIUM_SCREENSHOT_DIR = PROJECT_DIR.child('selenium-screenshots')`
		`+ DEBUG_TOOLBAR_CONFIG = {`
		`+ 'SHOW_TOOLBAR_CALLBACK': lambda x: True`
		`+ }`

		`+ DEBUG_TOOLBAR_PATCH_SETTINGS = False`

		`# Uses a separate Docker container to act as the Redis server`
		`CELERY_BROKER_URL = 'redis://redis:6379/0'`

happinesspackets/urls.py

file modified

		`@@ -4,11 +4,17 @@`
		`from django.conf import settings`
		`from django.conf.urls import include, url`
		`from django.contrib import admin`
		`+ from django.conf.urls.static import static`

		`urlpatterns = [`
		`url(r'^oidc/', include('mozilla_django_oidc.urls')),`
		`url(r'^', include('happinesspackets.messaging.urls', namespace="messaging")),`
		`]`
		`+ if settings.DEBUG:`
		`+ import debug_toolbar`
		`+ urlpatterns += [`
		`+ url(r'^__debug__/', include(debug_toolbar.urls)),`
		`+ ]`

		`if settings.ADMIN_ENABLED or settings.DEBUG:`
		`urlpatterns.append(url(r'^drunken-octo-lama/', include(admin.site.urls)))`

templates/messaging/start.html

file modified

-5

		`@@ -18,11 +18,6 @@`
		`you work with are happy to work with you, is an awesome feeling. With Fedora Happiness Packets, we're`
		`trying to spread that feeling.`
		`</p>`
		`-`
		`- <p class="text-center">`
		`- <a class="btn btn-primary btn-lg btn-responsive" href="{% url 'messaging:send' %}" role="button">Send some happiness now! <img class="emoji" src="static/images/emoji/loveletter.png" alt="💌" title="Love letter" aria-label="Emoji: Love letter"></a>`
		`- </p>`
		`-`
		`<h2>How does it work?</h2>`
		`<p>`
		`Openly expressing appreciation, gratitude, or happiness to other people can be difficult. This is especially`

feisal commented 5 years ago

update the readme file to include how to create virtual environment and how to install requirement for your specific setting you wanna use and how to set settings.
This changes will be good for newcomers as it was a challenge to me when it comes to set up my development environment