Added placeholder for documentation
This commit is contained in:
38
docs/getting-started/quickstart.md
Normal file
38
docs/getting-started/quickstart.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# Quick Start Guide
|
||||
|
||||
Get up and running with the Letzshop Import API in 5 minutes.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Python 3.10+
|
||||
- Git
|
||||
|
||||
## Quick Setup
|
||||
|
||||
```bash
|
||||
# 1. Clone and setup
|
||||
git clone <your-repo>
|
||||
cd letzshop-import
|
||||
make setup
|
||||
|
||||
# 2. Start development
|
||||
make dev
|
||||
```
|
||||
|
||||
## First API Call
|
||||
|
||||
```bash
|
||||
# Check health
|
||||
curl http://localhost:8000/health
|
||||
|
||||
# View API docs
|
||||
open http://localhost:8000/docs
|
||||
```
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Database Setup](database-setup.md) - Configure your database
|
||||
- [Configuration](configuration.md) - Environment configuration
|
||||
- [API Documentation](../api/index.md) - Explore the API
|
||||
|
||||
*This guide is under development. For detailed instructions, see [Installation](installation.md).*
|
||||
Reference in New Issue
Block a user