DocSentry / PUSH.md
SpandanM110's picture
DocSentry - bank document forensics with 4 tabs
05b69f8
|
Raw
History Blame Contribute Delete
2.48 kB
# Push to GitHub - One-time setup
Your repo: https://github.com/SpandanM110/Doc-Sentry.git
The `.gitignore` is configured to exclude the 826 MB `cheque data/` folder, the
~250 MB `data/` folder, the `.venv`, and other heavy stuff. **Only ~400 KB of
code, docs, and 26 sample files will be pushed.**
## Step 1 - Open PowerShell in your project folder
```powershell
cd "C:\Users\HP\Desktop\Anomaly Based project"
```
## Step 2 - Initialize git + commit
Run these one by one (or paste all at once):
```powershell
git init -b main
git config user.email "spandanmukherjeegithub@gmail.com"
git config user.name "Spandan"
git add .
git status # confirm only ~30 files staged (not the big data/ folders)
git commit -m "Initial commit: DocSentry - bank document forensics with 4 tabs"
```
## Step 3 - Connect to GitHub + push
```powershell
git remote add origin https://github.com/SpandanM110/Doc-Sentry.git
git push -u origin main
```
When prompted for credentials:
- **Username:** your GitHub username (`SpandanM110`)
- **Password:** a **Personal Access Token** (NOT your GitHub password)
If you don't have a PAT yet:
1. Go to https://github.com/settings/tokens
2. Click **Generate new token (classic)**
3. Give it a name (e.g. "DocSentry repo")
4. Tick the **repo** scope
5. Click Generate, then **copy the token** (it's only shown once)
6. Paste it as the password when git prompts
## Step 4 - Verify
Open https://github.com/SpandanM110/Doc-Sentry in your browser.
You should see all your files: `app.py`, `forensics.py`, `compliance.py`,
`docsentry_master.ipynb`, the markdown docs, and the `sample_data/` folder.
## Future pushes (after first time)
```powershell
git add .
git commit -m "describe what you changed"
git push
```
The push uses your cached credentials automatically after the first time.
## If something goes wrong
**"Repository already exists" or other init errors**
```powershell
# delete the .git folder and start over
rmdir /s /q .git
git init -b main
```
**Files too large to push**
If you ever accidentally add a large file (> 100 MB):
```powershell
git rm --cached path/to/big/file
echo path/to/big/file >> .gitignore
git add .gitignore
git commit -m "exclude large file"
```
**Want to add the cheque data later?**
It's 826 MB - GitHub will reject it. Two options:
1. Use Git LFS (`git lfs install` + `git lfs track "*.tif"`)
2. Document the dataset source in DATASETS.md instead and have users
download it themselves (recommended)