Skip to content

A new era of book reading and sharing motivation...

License

Notifications You must be signed in to change notification settings

prathampt/perspectify

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

54 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PERSPECTIFY

A new era of book reading and sharing motivation...

license last-commit repo-top-language repo-language-count

Developed with these software and tools:

HTML5 Python Django


Quick Links


Overview

This website is made for giving people a daily boost of motivation...


Features

This is entirely made using a framework of python Django, and styled using CSS only...


Glimpse

Structure in a nut shell

---

Repository Structure

└── perspectify/
    ├── LICENSE
    ├── README.md
    ├── core
    │   ├── __init__.py
    │   ├── admin.py
    │   ├── apps.py
    │   ├── forms.py
    │   ├── migrations
    │   │   ├── 0001_initial.py
    │   │   ├── 0002_delete_userprofile.py
    │   │   ├── 0003_initial.py
    │   │   ├── 0004_remove_userprofile_place_userprofile_email_and_more.py
    │   │   └── __init__.py
    │   ├── models.py
    │   ├── signals.py
    │   ├── static
    │   │   └── core
    │   │       ├── about.css
    │   │       ├── contact.css
    │   │       ├── privacy_policy.css
    │   │       ├── profile.css
    │   │       └── styles.css
    │   ├── templates
    │   │   └── core
    │   │       ├── about.html
    │   │       ├── base.html
    │   │       ├── contact.html
    │   │       ├── login.html
    │   │       ├── privacyPolicy.html
    │   │       ├── profile.html
    │   │       └── signup.html
    │   ├── tests.py
    │   ├── urls.py
    │   └── views.py
    ├── items
    │   ├── __init__.py
    │   ├── admin.py
    │   ├── apps.py
    │   ├── data
    │   │   └── .trackme
    │   ├── forms.py
    │   ├── migrations
    │   │   ├── 0001_initial.py
    │   │   ├── 0002_remove_book_category_delete_category.py
    │   │   ├── 0003_alter_book_genre.py
    │   │   ├── 0003_alter_book_genre_savebook_delete_userbook.py
    │   │   ├── 0004_merge_20240310_1927.py
    │   │   └── __init__.py
    │   ├── models.py
    │   ├── randomImages
    │   │   └── .trackme
    │   ├── scripy.py
    │   ├── static
    │   │   └── items
    │   │       ├── book.css
    │   │       ├── bookList.css
    │   │       ├── bookShelf.css
    │   │       ├── card.css
    │   │       └── styles.css
    │   ├── templates
    │   │   └── items
    │   │       ├── base.html
    │   │       ├── books.html
    │   │       ├── detail.html
    │   │       └── forms.html
    │   ├── templatetags
    │   │   ├── __init__.py
    │   │   └── custom_filters.py
    │   ├── tests.py
    │   ├── urls.py
    │   └── views.py
    ├── manage.py
    ├── perspectify
    │   ├── __init__.py
    │   ├── asgi.py
    │   ├── settings.py
    │   ├── urls.py
    │   └── wsgi.py
    └── requirements.txt

Getting Started

Requirements

Ensure you have the following dependencies installed on your system:

  • Python: version 3.10

Installation

  1. Clone the perspectify repository:
git clone https://github.com/prathampt/perspectify
  1. Change to the project directory:
cd perspectify
  1. Install the dependencies:
pip install -r requirements.txt

Running perspectify

Use the following command to run perspectify:

python main.py

Contributing

Contributing Guidelines
  1. Fork the Repository: Start by forking the project repository to your GitHub account.
  2. Clone Locally: Clone the forked repository to your local machine using a Git client.
    git clone https://github.com/prathampt/perspectify
  3. Create a New Branch: Always work on a new branch, giving it a descriptive name.
    git checkout -b dev_yourname
  4. Make Your Changes: Develop and test your changes locally.
  5. Commit Your Changes: Commit with a clear message describing your updates.
    git commit -m 'Implemented new feature x.'
  6. Push to GitHub: Push the changes to your forked repository.
    git push origin new-feature-x
  7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.

Once your PR is reviewed and approved, it will be merged into the main branch.

Acknowledgments

Contributors:


Pratham Tandale

Anjali Tekam

Mehmood Deshmukh