NeighbourCheck

NeighbourCheck is a Django-based web application designed for community management and engagement. This document covers the basics of setting up the project, the creation of the users app, and the folder structure.

Table of Contents

• Introduction
• Features
• Project Setup
• Folder Structure
• Users App
• Static Files

Introduction

NeighbourCheck is a web application that allows users to register, log in, and manage their profiles. It is built using the Django framework and follows a modular structure for better code management and scalability.

Features

• User Registration
• User Login
• User Profile Management
• Logout Functionality

Project Setup

To set up the project locally, follow these steps:

1. Clone the Repository:

   git clone https://github.com/YOUR_USERNAME/NeighbourCheck.git
   cd NeighbourCheck

2. Create and Activate a Virtual Environment:

   python -m venv env
   source env/bin/activate  # On Windows use `env\Scripts\activate`

3. Install Dependencies:

   pip install -r requirements.txt

4. Apply Migrations:

   python manage.py makemigrations
   python manage.py migrate

5. Create a Superuser:

   python manage.py createsuperuser

6. Run the Development Server:

   python manage.py runserver

7. Access the Application:

   Open your web browser and navigate to http://127.0.0.1:8000/

Folder Structure

The project follows a standard Django project structure with some additional directories for static files and templates.

NeighbourCheck/ ├── NeighbourCheck/ │ ├── init.py │ ├── asgi.py │ ├── settings.py │ ├── urls.py │ ├── views.py │ ├── wsgi.py ├── content/ │ ├── init.py │ ├── admin.py │ ├── apps.py │ ├── forms.py │ ├── models.py │ ├── views.py │ ├── urls.py │ ├── templates/ │ │ └── content/ ├── users/ │ ├── init.py │ ├── admin.py │ ├── apps.py │ ├── forms.py │ ├── models.py │ ├── views.py │ ├── urls.py │ ├── templates/ │ │ └── users/ │ │ ├── register.html │ │ ├── login.html │ │ ├── profile.html │ │ └── logout.html ├── static/ │ └── css/ │ └── styles.css ├── templates/ │ ├── base_generic.html │ └── home.html ├── manage.py └── db.sqlite3

Users App

The users app handles user registration, login, profile management, and logout functionality.

• Views:

  • register: Handles user registration.
  • login: Handles user login (Django built-in).
  • profile: Displays the user's profile.
  • logout: Handles user logout (Django built-in).

• Templates:

  • register.html: Template for the registration page.
  • login.html: Template for the login page.
  • profile.html: Template for the profile page.
  • logout.html: Template for the logout page.

Static Files

Static files such as CSS are stored in the static directory. The main CSS file is located at static/css/styles.css.

Contributing

Contributions are welcome! Please submit a pull request or open an issue to discuss your changes.

License

This project is licensed under the MIT License. See the LICENSE file for more details.