Skip to content

Django web app for charity event organisers to connect and collaborate.

Notifications You must be signed in to change notification settings

ExpressHermes/Helping-Hand

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

78 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Helping Hand

Slack

A social platform built for the organizers charity events to connect with each other to organize bigger events and thus help more people.

Frontend

The frontend is fast and interactive. It is built with HTML, CSS, Bootstrap 4 and Vanilla JavaScript.

Backend

The backend is built with Django framework. It uses SQL based database.

Demo Screenshots

Register page Login page Event creation page Events List page

Installation

Make sure following softwares are installed in your computer:

  • Python 3
  • Git
  • First you need to clone the repository

    git clone https://github.com/ExpressHermes/Helping-Hand.git
    
  • Install all required dependencies in a virtual environment

    cd <directory_name>
    python3 -m venv venv
    source venv/bin/activate
    pip install -r requirements.txt
    
  • Run the backend on local server

    cd <directory_name>
    source venv/bin/activate
    cd Helping-Hand
    python manage.py runserver
    
  • To create superuser, run following command inside Helping-Hand folder

    python manage.py createsuperuser
    
  • For a "OperationalError", run the following command

    python manage.py makemigrations mainapp
    python manage.py migrate
    

Setting the environment variables

If you are facing the problem in login through Google, follow these steps:

  • Create a .env file in the project directory of Helping Hands.
  • Follow the variable names from .env.sample file but values of that variables are dummy so make sure to update.
  • Now for getting the client id and secret key, Go to https://console.cloud.google.com/ .
  • Create new project and give it a name then go to your project and configure your OAuth Consent Screen.
  • After that Go to API & Services and then credentials, create the OAuth Key.
  • Copy paste the Client id and secret key in the .env file.

Contribution

  • Fork and clone the repo.

  • To avoid merge conflicts, make sure to set upstream in your git.

    git remote add upstream https://github.com/ExpressHermes/Helping-Hand.git
    
  • Whenever you want to pull changes from main repo, run:

    git pull upstream master
    
  • Create your feature branch

    git checkout -b <feature-name>
    
  • Commit your changes

    git commit -am "Meaningful commit message"
    
  • Push to the branch

    git push origin <feature-name>
    
  • If you see any bug or you have a feature suggestion, create an issue.

  • Start working on an issue only after it has been approved by the maintainer.

  • Wait till the end of the day to get the reply on an issue or review of a PR.

About

Django web app for charity event organisers to connect and collaborate.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published