https://github.com/zakharb/reactapi

React and FastAPI
https://github.com/zakharb/reactapi

docker docker-compose fastapi postgresql react

Last synced: 11 months ago
JSON representation

React and FastAPI

• Host: GitHub
• URL: https://github.com/zakharb/reactapi
• Owner: zakharb
• License: gpl-3.0
• Created: 2022-09-06T16:19:46.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-15T03:27:51.000Z (about 2 years ago)
• Last Synced: 2025-04-13T03:18:33.017Z (about 1 year ago)
• Topics: docker, docker-compose, fastapi, postgresql, react
• Language: JavaScript
• Homepage:
• Size: 1.26 MB
• Stars: 10
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


  

  







  






  

  





  



## :blue_square: Getting Started

[ReactAPI](https://github.com/zakharb/reactapi) is an example of user interface based on  

- JavaScript library [React](https://en.wikipedia.org/wiki/React_(JavaScript_library))on the Frontend   

- [FastAPI](https://en.wikipedia.org/wiki/FastAPI) and [Postgres](https://en.wikipedia.org/wiki/PostgreSQL) on the Backend   

For CRUD operations is used `Tickets-Comments` model  

> The user can create `Tickects` and add `Comments` to them  

The UI is in reactive mode and notifies changes immediately  

Backend works in async mode with high performance and lightweight API  

### Requirements

![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB)

![FastAPI](https://img.shields.io/badge/FastAPI-005571?style=for-the-badge&logo=fastapi)

![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white)

![Postgres](https://img.shields.io/badge/postgres-%23316192.svg?style=for-the-badge&logo=postgresql&logoColor=white)

![Nginx](https://img.shields.io/badge/nginx-%23009639.svg?style=for-the-badge&logo=nginx&logoColor=white)

### Installing

Clone the project

```

git clone git@github.com:zakharb/reactapi.git

cd reactapi

```

Start docker-compose

```

docker-compose up -d

```



  



## :blue_square: Usage  

### Frontend  

Create, update, delete [Tickets](http://localhost:3000/tickets)    



  



Create, update, delete [Comments](http://localhost:3000/comments)  



  



### Backend    

Get, put, update, delete `Tickets` via API [Tickets](http://localhost:8080/api/v1/tickets/docs)  



  



Get, put, update, delete `Comments` via API [Comments](http://localhost:8080/api/v1/comments/docs)  



  



## :blue_square: Deployment

Edit `Dockerfile` for each Microservice and deploy container

## :blue_square: Versioning

Using [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/zakharb/reactapi/tags). 

## :blue_square: Authors

* **Zakhar Bengart** - *Initial work* - [Ze](https://github.com/zakharb)

See also the list of [contributors](https://github.com/zakharb/reactapi/contributors) who participated in this project.

## :blue_square: License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation - see the [LICENSE](LICENSE) file for details