Camplight task

Project to manage users with a UI, Backend and Database, all deployable through docker compose.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contact
5. Acknowledgments

About The Project

The process described below outlines the methodology for how this project/task was built, what technologies and how to set it up locally.

Built With

This section lists any major frameworks/libraries used to bootstrap the project.

• ->
• ->
• 
• 

(back to top)

Getting Started

Instructions on how to get started

Prerequisites

Docker with Docker Compose must be installed

Installation

git clone https://github.com/PeterYordanov/camplight-task.git

cd camplight-task

docker-compose up --build

(back to top)

Roadmap

• React frontend
  • Users service
  • Health service
  • Input Validation
• Backend
  • Users (CRUD)
    • Create
      • Upon creation, add an AI-genereated image (Cheated a bit here with thispersondoesnotexist.com)
    • Read
    • Update
    • Delete
  • Health Service
    • Ping
    • Test DB
  • DB Setup
    • Tables set up on startup
    • Seed data
• Deployment (Local)
  • Docker compose
  • Frontend
  • Deployment
  • PostgreSQL Database
• Security
  • Input validation with Pydantic on the backend
  • CORS
• Unit Tests
• Swagger

(back to top)

Authors

Petar Yordanov - [email protected]

(back to top)