https://github.com/mohamedbsh/creche-app
👩🏻🍼👩🏻🍼👩🏻🍼
https://github.com/mohamedbsh/creche-app
Last synced: about 1 month ago
JSON representation
👩🏻🍼👩🏻🍼👩🏻🍼
- Host: GitHub
- URL: https://github.com/mohamedbsh/creche-app
- Owner: MohamedBsh
- Created: 2024-11-24T17:23:02.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-12-06T08:05:09.000Z (5 months ago)
- Last Synced: 2024-12-12T00:40:21.881Z (5 months ago)
- Language: Python
- Homepage:
- Size: 206 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# creche-api
## Table of Contents
- [Introduction](#introduction)
- [Architecture](#architecture)
- [API Endpoints](#api-endpoints)
- [Parents](#parents)
- [Children](#children)
- [Caregivers](#caregivers)
- [Enrollments](#enrollments)
- [Creches](#creches)
- [Running the Application](#running-the-application)
- [Using Docker](#using-docker)
- [Accessing the API Documentation](#accessing-the-api-documentation)
- [TODO](#todo)
## Introduction
This project is a REST API for managing operations related to creches, children, caregivers, and enrollments. The API allows for creating, reading, updating, and deleting records in a database.
## Architecture
The API is organized into several layers:
- **Lower Level: Database**
The database stores all information related to crèches, children, caregivers, and enrollments.
- **Operations on Database**
This layer contains the business logic for interacting with the database, including creating, reading, updating, and deleting records.
- **API Router Layer**
This layer allows us to choose which type of operations to perform based on the HTTP request. It manages the routes and endpoints of the API.
## API Endpoints
### Parents
- **Get All Parents**
```bash
curl -X GET "http://localhost:8000/parents"
```
- **Create a Parent**
```bash
curl -X POST "http://localhost:8000/parents" -H "Content-Type: application/json" -d '{"first_name": "Jane", "last_name": "Doe", "email_address": "[email protected]", "phone_number": "+123456789"}'
```
- **Get a Parent by ID**
```bash
curl -X GET "http://localhost:8000/parents/1"
```
- **Update a Parent**
```bash
curl -X PUT "http://localhost:8000/parents/1" -H "Content-Type: application/json" -d '{"first_name": "Jane", "last_name": "Smith", "email_address": "[email protected]", "phone_number": "+987654321"}'
```
- **Delete a Parent by ID**
```bash
curl -X DELETE "http://localhost:8000/parents/1"
```
- **Get Children of a Parent**
```bash
curl -X GET "http://localhost:8000/parents/1/children"
```
- **Add a Child to a Parent**
```bash
curl -X POST "http://localhost:8000/parents/1/children" -H "Content-Type: application/json" -d '{"child_id": 1}'
```
- **Remove a Child from a Parent**
```bash
curl -X DELETE "http://localhost:8000/parents/1/children/1"
```
### Children
- **Get All Children**
```bash
curl -X GET "http://localhost:8000/children"
```
- **Create a Child**
```bash
curl -X POST "http://localhost:8000/children" -H "Content-Type: application/json" -d '{"first_name": "John", "last_name": "Doe", "date_of_birth": "2020-01-01", "parent_id": 1}'
```
- **Get a Child by ID**
```bash
curl -X GET "http://localhost:8000/children/1"
```
### Caregivers
- **Get All Caregivers**
```bash
curl -X GET "http://localhost:8000/caregivers"
```
- **Create a Caregiver**
```bash
curl -X POST "http://localhost:8000/caregivers" -H "Content-Type: application/json" -d '{"first_name": "Jane", "last_name": "Doe", "qualifications": "Bachelor Degree in Early Childhood Education", "years_of_experience": 5, "caregiver_email_address": "[email protected]", "caregiver_phone_number": "+123456789"}'
```
- **Get a Caregiver by ID**
```bash
curl -X GET "http://localhost:8000/caregivers/1"
```
### Enrollments
- **Get All Enrollments**
```bash
curl -X GET "http://localhost:8000/enrollments"
```
- **Create an Enrollment**
```bash
curl -X POST "http://localhost:8000/enrollments" -H "Content-Type: application/json" -d '{"start_date": "2024-01-01", "end_date": "2024-01-05", "child_id": 1, "caregiver_id": 1, "creche_id": 1, "parent_id": 1, "price": 100}'
```
- **Get an Enrollment by ID**
```bash
curl -X GET "http://localhost:8000/enrollments/1"
```
- **Delete an Enrollment by ID**
```bash
curl -X DELETE "http://localhost:8000/enrollments/1"
```
- **Get Enrollments by Creche and Price**
```bash
curl -X GET "http://localhost:8000/enrollments/creche/1/price/100"
```
### Creches
- **Get All Creches**
```bash
curl -X GET "http://localhost:8000/creches"
```
- **Create a Creche**
```bash
curl -X POST "http://localhost:8000/creches" -H "Content-Type: application/json" -d '{"name": "Creche A", "address": "123 Rue Exemple", "capacity": 30}'
```
- **Get a Creche by ID**
```bash
curl -X GET "http://localhost:8000/creches/1"
```
## Running the Application
### Using Docker
To run the FastAPI application using Docker, follow these steps:
1. **Build the Docker image:**
```bash
docker build -t creche-api .
```
2. **Run the Docker container:**
```bash
docker run -d --name creche-api -p 8000:8000 creche-api
```
3. **Access the application:**
You can access the FastAPI application at the following URL:
```bash
http://localhost:8000
```
### Running Locally (Without Docker)
If you prefer to run the application locally without Docker, use the following command:
```bash
uvicorn main:app --reload
```
- The `--reload` option allows the server to automatically reload when you make changes to the code.
## Accessing the API Documentation
You can access the interactive API documentation provided by FastAPI by navigating to the following URL in your web browser:
```bash
http://localhost:8000/docs
```
## TODO
- [ ] **Implement Authentication and Authorization**
Add user authentication and authorization to secure the API endpoints.
- [ ] **Add Unit Tests**
Write unit tests for all API endpoints and database operations to ensure code reliability and facilitate future changes.
- [ ] **Frontend Integration**
Develop a frontend application that interacts with the API to provide a user-friendly interface for managing crèches, children, caregivers, enrollments and parents.
Deploy my docker image to a cloud service provider.
- [X] **Containerization**
Containerizing the application using Docker for easier deployment and scalability.