melisaates / my_first_backend_project

CRUD - Backend Project

This project contains a backend application developed in Python using the FastAPI framework to manage a PostgreSQL database. The project allows you to perform CRUD (Create, Read, Update, Delete) operations and offers many customizable features.

Getting Started

To run the project on your local machine, follow these steps:

1. Clone this repository or download it as a ZIP file.
2. Create a PostgreSQL database or use an existing one.
3. Create a .env configuration file and add your database connection details:

```env```` DATABASE_URL=postgresql://username:password@localhost/dbname

Run the project:

bash

uvicorn main:app --reload

Access the FastAPI automatic documentation interface by opening http://localhost:8000/docs in your browser.

Usage

The core functionalities of this project are explained below:

GET /items: Retrieves all items.
GET /items/{item_id}: Retrieves a specific item.
POST /items: Adds a new item.
PUT /items/{item_id}: Updates a specific item.
DELETE /items/{item_id}: Deletes a specific item.

All available requests and responses for these operations are detailed in the FastAPI automatic documentation interface. Configuration

The project configuration is located in the app/config.py file. You can customize your project by editing this file. Contributing

If you wish to contribute to this project, please follow these steps:

Create a fork of this repository on your GitHub account.
Create a new branch and make your changes.
Upload your changes (commit) and create a pull request.
We will review your contribution and may accept it.

License

This project is licensed under the MIT License. For more information, check the LICENSE file.