PR#107: update readme - fedora-commops/fedora-happiness-packets

fedora-commops / fedora-happiness-packets

#107 update readme

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

Unknown source update-readme into master

feysal-Ibrahim • 5 years ago

2c50280

README.md

file modified

+11

		`@@ -13,6 +13,9 @@`
		`- Docker`
		`- Docker-Compose`
		`- Python (Version 3 is recommended)`
		`+ - Django(1.11.5)`
		`+`
		`+`

		`## Installing`

		`@@ -28,6 +31,14 @@`
		`cd fedora-happiness-packets`
		```

		`+ 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 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:`

		```

feisal commented 5 years ago

Update the readme file to include some important prerequisite the project needs and some configuration in the setting file needed to run the module in your localhost.

This changes is important for newcomers because it solves many problems i think newcomers will come across during project setup and preparation of project environment and installation of requirement needed for the module to run.

jflory7 commented 5 years ago

@feisal This is a duplicate of #106. Please wait until your last pull request of the same title is reviewed before opening another pull request. I'm closing this one as a duplicate.

Pull-Request has been closed by jflory7

5 years ago

Pull-Request has been reopened by feisal

5 years ago

feisal commented 5 years ago

@jflory7 I have removed other unnecessary files you said were not needed for this PR

Edited 5 years ago by feisal

jflory7 commented 5 years ago

@feisal Thanks. :thumbsup:

I had a question in #106 about this change. These steps seem to contradict the Docker installation method. Did you use Docker when setting up your development environment?

Metadata Update from @jflory7:
- Pull-request tagged with: improvement, type - docs, type - summer coding
- Request assigned

5 years ago

Metadata Update from @jflory7:
- Pull-request tagged with: needs info

5 years ago

feisal commented 5 years ago

@jflory7 yes i have installed docker using this link https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=94798094#space-menu-link-content thou i was not familiar with docker before, i highly welcome your assistance in these.

Edited 5 years ago by feisal

feisal commented 5 years ago

@jflory7 waiting for your final review and hopefully merging.

jflory7 commented 5 years ago

Hi @feisal, #65 was merged and it created the new project documentation on readthedocs.org. This means the development environment instructions are no longer in the README. Sorry for the confusion.

Please see #100 again – I updated the links for our documentation in the ticket. Follow the steps listed there, and if something is still confusing, we can improve the new docs.

Metadata Update from @jflory7:
- Pull-request untagged with: needs info

5 years ago

Pull-Request has been closed by jflory7

5 years ago

feisal commented 5 years ago

@jflory7 ok then. I will check the documentation and will contribute to that .