Skip to content

Commit 4d3d4d7

Browse files
committed
readme
1 parent b2beac6 commit 4d3d4d7

2 files changed

Lines changed: 63 additions & 1 deletion

File tree

README.md

Lines changed: 63 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,63 @@
1-
# basar-backend
1+
# Nordakademie *Bazzar*
2+
3+
<p align="center">
4+
<img src="./assets/banner.png" alt="Nordakademie Basar Banner" width="100%">
5+
</p>
6+
7+
> # A digital marketplace for the Nordakademie community in Hamburg
8+
9+
## About
10+
11+
Nordakademie Bazzar is a marketplace platform designed for students and staff at Nordakademie Hochschule der Wirtschaft in Hamburg. Similar to eBay or classifieds platforms, it enables the community to buy, sell, and share various offerings including:
12+
13+
- Course materials and textbooks
14+
- Flat and apartment listings
15+
- Weekend seminars and events
16+
- General marketplace items
17+
18+
## Features
19+
20+
- **Post Listings** - Create and manage marketplace posts with images and detailed descriptions
21+
- **Community Interaction** - Comment on posts and connect with other members
22+
- **Image Support** - Upload multiple images with automatic optimization
23+
- **Easy Payments** - Integrated PayPal support for transactions
24+
- **Search & Filter** - Find listings by creator, tags, or category
25+
26+
## Quick Start
27+
28+
### Using Docker (Recommended)
29+
30+
```bash
31+
docker-compose up -d
32+
```
33+
34+
The application will be available at `http://localhost:42000`
35+
36+
### Manual Setup
37+
38+
1. Ensure MongoDB is running
39+
2. Copy `.env.example` to `.env` and configure your settings
40+
3. Run the application:
41+
```bash
42+
go run main.go
43+
```
44+
45+
## Health Check
46+
47+
Check if the service is running:
48+
49+
```
50+
GET http://localhost:42000/health
51+
```
52+
53+
## Documentation
54+
55+
For detailed API documentation, see [API_DOCS.md](./API_DOCS.md)
56+
57+
## About Nordakademie
58+
59+
Nordakademie Hochschule der Wirtschaft is a state-recognized private university located in Hamburg, Germany, specializing in business and technology education.
60+
61+
---
62+
63+
Built with ❤️ for the Nordakademie community

assets/banner.png

16.3 KB
Loading

0 commit comments

Comments
 (0)