https://github.com/sibyx/hitchhiking-diary-server
Hitchhiking Diary Server
https://github.com/sibyx/hitchhiking-diary-server
Last synced: 7 months ago
JSON representation
Hitchhiking Diary Server
- Host: GitHub
- URL: https://github.com/sibyx/hitchhiking-diary-server
- Owner: Sibyx
- Created: 2024-06-28T00:03:04.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-07-12T17:21:27.000Z (over 1 year ago)
- Last Synced: 2025-02-07T12:47:01.223Z (8 months ago)
- Language: JavaScript
- Size: 8.21 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Hitchhiking Diary Server
FastAPI-powered server service for the iOS application for documenting hitchhiking travels. Designed to effortlessly
synchronize your hitchhiking adventures across your family and friends so they know you are safe.
**Work in progress**
## Features
- [X] **Mobile App Sync**: Synchronization services for [hitchhiking-diary-ios](https://github.com/Sibyx/hitchhiking-diary-ios/)
- [X] **Public dashboard**: Public dashboard to share your journey with your friends and family!
- [X] **Image generator**: Image generator for Instagram stories and OpenGraph images
- [ ] **GeoServer**: Deploy custom GeoServer for customized map tiles and distance calculations
## Getting Started
### From scratch
```shell
# Clone the repository
git clone git@github.com:Sibyx/hitchhiking-diary-server.git hitchhiking-diary-server
# Create environment and install dependencies
cd hitchhiking-diary-server
python -m venv .venv
source .venv/bin/active
poetry install
# Create configuration (edit the .env)
cp .env.example .env
# Run server
uvicorn main:app --reload
```
## CLI
The server comes with some CLI to easy setup and maintenance:
| Command | Description |
|------------------------------------------------------|----------------------------------|
| `python -m hitchhiking_diary_server.cli create-user` | Creates a new user |
| `python -m hitchhiking_diary_server.cli openapi` | Generate OpenAPI definition file |
---
Created with ❤️ using ☕️ and 🍓 during my stay in 🇳🇴
If you enjoy using this project, consider donating! Your donations will go towards therapy sessions because
I'm an alcoholic and substance abuser and this is my cry for help. Cheers 🍻!