- Project Summary: Brief overview of the application.
- Features: What the app offers.
- Technologies Used: List of tech used in the project.
- Setup Instructions: How to get the app running locally.
- Usage: Instructions for using the app.
- Project Structure: A visual breakdown of the directory structure.
- Future Features: Upcoming features planned for the app.
- Contributing: Guidelines for contributing to the project.
- License: License information.
Petnote is a web application designed to help pet owners track important information about their pets. Whether it's for recording daily care, health updates, or general notes, Petnote makes it easy for owners to stay organized and keep track of their pets' well-being.
- Pet Profiles: Add and manage multiple pets with unique profiles.
- Health Tracking: Track your pet’s health data like age, weight, and breed.
- User Management: Users can sign up, log in, and manage their own pets.
- Frontend: Pending
- Backend: Python, Django
- Database: SQLite (for local development), PostgresSQL for production environment
- Deployment: Pending
- Authentication: Django’s built-in user authentication system
To get started with Petnote on your local machine:
- Python 3.x
- Django 5.x
- Virtual environment (recommended)
- Clone the Repository:
git clone https://github.com/SamTheSoftwareEngineer/petnote.git
cd petnote- Create a Virtual Environment:
python3 -m venv venv
source venv/bin/activate # For Windows: venv\Scripts\activate- Install Dependencies
pip install -r requirements.txt- Apply Migrations
python3 manage.py migrate- Create a Superuser (for admin access)
python3 manage.py createsuperuser- Run the development server
python3 manage.py runserver- Access the application
- Go to http://127.0.0.1:8000/ in your browser to use the app.
- Access the admin interface at http://127.0.0.1:8000/admin/.
Pending