search

ContriHUB / ContriHub-18

http://contrihubs.herokuapp.com - :snowman: :cyclone: ContriHub is an event under Avishkar-18 where we are expecting to get more and more people involved in Opens Source activities.
7 stars 33 forks source link

Modify README.md for setup in Linux/Windows/Mac #49

Closed deepak-bharti-deel closed 6 years ago

deepak-bharti-deel commented 6 years ago

Currently README.md is not very helpful for all kind of users, so update it so that all the users can understand and setup project locally.

  1. Instructions for Windows
  2. Instructions for Linux
  3. Instructions for Mac

You have to put following things for all the platforms -

  1. Installing Python.
  2. Creating virtual environment activating and deactivating it
  3. Installing all the requirements and mention if their are some exceptions while installations
  4. Any changes if required in ContriHub/settings.py for running project in local like tell how to setup some environment variables used in ContriHub/settings.py file.
  5. How to setup different databases like Postgresql, Mysql, sqlite.

You can add any details complete/partially like adding how to setup Python and virtual environment on Mac or How to setup Database on Windows. You will get 5 -10 points accordingly for each contribution :smile:

deepak-bharti-deel commented 6 years ago

You need to create a request on https://contrihubs.herokuapp.com/ once. If you add more things in different PRs your points will be updated accordingly :smile: