updated README.md
parent
3952101712
commit
45836fad1a
BIN
link_tracker.db
BIN
link_tracker.db
Binary file not shown.
29
readme.md
29
readme.md
|
|
@ -88,6 +88,29 @@ INFO: Uvicorn running on http://0.0.0.0:8000
|
|||
|
||||
**The server is now running!** Keep this window open while you use the system.
|
||||
|
||||
## Syncing Your Data
|
||||
|
||||
### Sync to Central Server
|
||||
|
||||
Open your web browser and go to:
|
||||
```
|
||||
http://localhost:8000/sync/to-central
|
||||
```
|
||||
|
||||
This will sync all your captured data to the central server. **Important:** You should do this regularly to ensure your data is backed up and available to other team members.
|
||||
|
||||
### Check Sync Status
|
||||
|
||||
To check if your data is properly synced, visit:
|
||||
```
|
||||
http://localhost:8000/sync/status
|
||||
```
|
||||
|
||||
This will show you:
|
||||
- How many pages are synced
|
||||
- When the last sync occurred
|
||||
- If there are any pages waiting to be synced
|
||||
|
||||
## Getting Your URL Reports
|
||||
|
||||
### For Colinkiri Indexing Service
|
||||
|
|
@ -149,6 +172,11 @@ To stop the server, go back to your Terminal/Command Prompt window and press `Ct
|
|||
- Check that you're using the correct URL: `http://localhost:8000`
|
||||
- Try refreshing your browser
|
||||
|
||||
**Sync issues:**
|
||||
- Check the sync status page to see if there are any problems
|
||||
- Make sure you're connected to the internet
|
||||
- Try restarting the server if sync seems stuck
|
||||
|
||||
## Other Available Endpoints
|
||||
|
||||
These are for advanced users or developers:
|
||||
|
|
@ -194,3 +222,4 @@ If you run into issues:
|
|||
2. Make sure you're in the correct folder when running commands
|
||||
3. Check that the server is running before trying to access URLs
|
||||
4. Try restarting the server if something seems stuck
|
||||
5. If sync issues occur, check the sync status page for details
|
||||
|
|
@ -1,3 +1,16 @@
|
|||
fastapi==0.104.1
|
||||
uvicorn[standard]==0.24.0
|
||||
pydantic==2.8.2
|
||||
requests==2.31.0
|
||||
python-dotenv==1.0.0
|
||||
sqlalchemy==2.0.27
|
||||
aiohttp==3.9.3
|
||||
python-multipart==0.0.9
|
||||
typing-extensions>=4.8.0
|
||||
starlette>=0.27.0
|
||||
anyio>=3.7.1
|
||||
click>=8.0.0
|
||||
h11>=0.8.0
|
||||
httptools>=0.5.0
|
||||
websockets>=10.4
|
||||
watchfiles>=0.13
|
||||
|
|
|
|||
Loading…
Reference in New Issue