An open API service indexing awesome lists of open source software.

https://github.com/alejadiez/mi_roulotte_api

Backend API for a blog where I share our family adventures and travel experiences on the road with our caravan.
https://github.com/alejadiez/mi_roulotte_api

api-rest authentication drizzle-orm endpoints typescript

Last synced: 8 months ago
JSON representation

Backend API for a blog where I share our family adventures and travel experiences on the road with our caravan.

Awesome Lists containing this project

README

          

# Mi Roulotte API

The backend API for Mi Roulotte, providing endpoints for trips, stages, content, and comments.

## 📦 Modules

This project is organized into separate modules for better structure and scalability:

- **`mi_roulotte_api`** → API layer built with [Hono](https://hono.dev/) for handling backend logic, database access, and endpoints.
- **`mi_roulotte_app`** → Admin app built with [Flutter](https://flutter.dev/) for managing trips, stages, content, and comments.
- **`mi_roulotte_blog`** → The main frontend blog built with [Astro](https://astro.build/), displaying trips, stages, and stories.
- **`mi_roulotte_studio`** → Admin panel built with [Angular](https://angular.dev/) for managing trips, stages, content, and comments.

## ✨ Features

- ⚡ REST endpoints for trips, stages, content, and comments
- 🔑 Handles authentication and authorization
- 💾 Integrates with [Cloudflare](https://cloudflare.com/)
- 🛠 Lightweight and optimized
- 🏗 Designed for scalability and modularity

## 🚀 Installation

1. Clone the repository:

```bash
git clone https://github.com/AlejaDiez/mi_roulotte_api.git
cd mi_roulotte_api
```

2. Install dependencies:

```bash
npm install
```

3. Build Cloudflare types:

```bash
npm run cf-typegen
```

4. Run the development server:

```bash
npm run dev
```

5. Open `http://localhost:3010` in your browser.

## 📦 Scripts

- `npm run dev` – Start development server
- `npm run deploy` – Deploy production build to cloudflare

## 📜 License

![Creative Commons License](https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png)

[Mi Roulotte](https://miroulotte.es) by Alejandro Diez Bermejo is licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-nc-sa/4.0/).