This is the documentation for the Pet Finder Django application.
The latest Docker image is available on Docker Hub at redwancse/pets-finder:latest.
Use this command to run the latest release:
docker run -dp 0.0.0.0:8080:8080 redwancse/pets-finder:latestAs part of our collaborative development process, the "develop" branch is open for your feature branches to be merged. Please follow these guidelines:
-
Clone the Repository:
git clone https://github.com/redwan-cse/pets-finder.git cd pets-finder -
Create a Feature Branch:
git checkout -b feature/your-feature-name develop
-
Make Changes:
- Make the necessary changes to your code.
git status
-
Commit Changes:
- Use
git add -uwhen you only want to stage modifications and deletions to tracked files - Use
git add .when you want to stage all changes, including new, modified, and deleted files. - You might need to use both commands or
git add -Ato stage all changes.
git add . git commit -m "Description of changes"
- Use
-
Push Feature Branch:
git push origin feature/your-feature-name
-
Create Pull Request:
- Go to the repository on [platform] and create a pull request targeting "develop."
git request-pull -p <base> <head>
Replace
<base>with the name of the branch you want to merge into (e.g., "develop") and<head>with the name of your feature branch (e.g., "feature/your-feature-name").For example:
git request-pull -p develop feature/your-feature-name
-
Review and Merge:
- Team members, please review and test pull requests promptly.
- Feel free to merge your own pull requests after receiving approval, or request reviews from others.
-
Keep "develop" Updated:
- Regularly pull changes from "develop" into your feature branch to avoid conflicts.
git pull origin develop
-
Test the beta images: Use this command to run the devlop branch image:
docker run -dp 0.0.0.0:8080:8080 redwancse/pets-finder:beta
$ docker-compose build $ docker-compose up $ docker-compose down