Skip to content

B3zaleel/Cartedepoezii

Repository files navigation

Cartedepoezii

Screenshot of Cartedepoezii

Introduction

Cartedepoezii is a social platform for poem writers and readers. The name Cartedepoezii was formed from the Romanian translation of the phrase "poem book". The project was inspired by my love for poems and my interest in the design and functioning of a social platform.

How It Works

This project is made up of multiple projects that include the API server and the web client. Data is stored in a PostgreSQL database, which can be remote or local to the API server. Images are stored using ImageKit.io's CDN. The web client is built using Vue with TypeScript and the API server is built using FastAPI. The web client makes requests to the API server and fetches images from ImageKit.io's CDN. The web client is the main interface for accessing Cartedepoezii. The image below summarizes the project's data flow.

Cartedepoezii architecture

Installation

Usage

To use this project, visit Vue SPA and FastAPI API server for usage instructions. It would be preferred if you start FastAPI API server first since Vue SPA depends on it.

Contributing

We welcome any contributions but please read our CONTRIBUTING guidelines before you make any.

Discussion

Related Projects

Licensing

Cartedepoezii is licensed under the MIT LICENSE.