Code Monkey home page Code Monkey logo

managefunds's Introduction

managefunds

A full stack funds management web app.

PRs Welcome

Manage Funds is a full stack web application where the users can manage Funds coming in their Programmes/Clubs/Organizations.

  • They can add a fund along with the associated budget.
  • Then they will also have the privilege to add expenses involved in that fund.
  • The count of transactions and balance will be tracked too.

Note : For testing Django's unittest module is used

                                  😃Hit that ⭐ button to show some ❤️           

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Any Code Editor (VS Code preferred)
Python version 3.7 or higher
Latest version of Git
A PythonAnywhere Account (for deploying the project on a live system)

Development Environment Setup : Windows

Step 1 : Downloading and Installing the Code Editor
Code Editor Link
Visual Studio Code Download it from here
Sublime Text 3 Download it from here
Atom Download it from here

Step 2 : Installing Python
  • Click on Download Python.

  • Click on the "Latest Python 3 Release - Python x.x.x" link.

      • Download the Windows x86-64 executable installer for 64-bit version of Windows
      • Download the Windows x86 executable installer for 32-bit version of Windows.
  • Make sure to check "Add Python 3.x to Path" in the setup window of the Installer.

Verify the installation from the command prompt using following command :

python --version

And the installed version of python will be printed.


Step 3 : Creating Project Directory

(Note : We are creating project directory in the desktop for easey and fast access)

cd desktop

mkdir myproject

cd myproject

Step 4 : Fork the Repository Cloning Repository using Git
git clone https://github.com/chiraag-kakar/managefunds.git

Step 5 : Creating Virtual Environment

Change the directory to the required one where the virtual environment will be created :

cd managefunds

Creating Virtual Environment named "vir" :

python -m venv vir

Activating "vir" :

vir\Scripts\activate

Command to deactivate "vir" :

deactivate

Step 6 : Installing Requirements

Note: Virtual Environment should be activated.

Upgrading pip to the latest version :

python -m pip install --upgrade pip

Installing requirements :

pip install -r requirements.txt

Step 7 : Creating Superuser and making database migrations to access the default Admin Panel
python manage.py makemigrations
python manage.py migrate
python manage.py createsuperuser

Step 8 : Running the Project in local server

Note: Virtual Environment should be activated.

Run the following command in the terminal :

python manage.py runserver

Congratulations for setting up the project locally.

Contributing

  • Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
  • For major changes, please open an issue first to discuss what you would like to change.

Note :

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b <your_branch_name>)
  3. Stage your Changes (git add .)
  4. Commit your Changes (git commit -m '<your_commit_message>')
  5. Push to the Branch (git push origin <your_branch_name>)
  6. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

AUTHOR : Chiraag Kakar

managefunds's People

Contributors

chiraag-kakar avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.