Skip to content

Latest commit

 

History

History
140 lines (105 loc) · 3.66 KB

README.md

File metadata and controls

140 lines (105 loc) · 3.66 KB

DetalBee Home Task

A full-stack project with a Django backend and a React frontend, orchestrated with Docker. This project enables efficient task management using SQLite as the database and includes containerized services for streamlined deployment.

Table of Contents

  1. Project Structure
  2. Technologies Used
  3. Setup and Installation
  4. Running the Application
  5. Testing
  6. API Endpoints
  7. Environment Variables

Project Structure

DetalBee_HomeTask/
├── dailynotes_api/         # Django backend
│   ├── authentication/     # Authentication module
│   ├── notes/              # Notes application logic
│   ├── media/              # Uploaded media files
│   ├── DockerFile          # Dockerfile for the backend
│   ├── db.sqlite3          # SQLite database
│   ├── requirements.txt    # Backend dependencies
│   └── manage.py           # Django project entry point
├── dailynotes-ui/          # React frontend
│   ├── src/                # React source files
│   ├── DockerFile          # Dockerfile for the frontend
│   ├── package.json        # Frontend dependencies
│   └── build/              # Build files (after running npm build)
├── docker-compose.yml      # Docker Compose configuration
└── README.md               # Project documentation

Technologies Used

Backend:

  • Django: Python framework for the backend API.
  • SQLite: Lightweight database for local development.
  • pytest: Testing framework for the backend.

Frontend:

  • React: JavaScript library for building the user interface.
  • Tailwind CSS: Utility-first CSS framework for styling.

Deployment and Development:

  • Docker: Containerization for the backend and frontend.
  • Docker Compose: Simplified multi-service orchestration.

Setup and Installation

Prerequisites:

  1. Install Docker: Get Docker
  2. Install Node.js: Get Node.js

Clone the Repository:

git clone https://github.com/your-username/DetalBee_HomeTask.git
cd DetalBee_HomeTask

Running the Application

Using Docker Compose:

  1. Build and start containers:

    docker-compose up --build

  2. Access the application:

    • Frontend: http://localhost:3000
    • Backend: http://localhost:8000

  3. Stopping containers:

    docker-compose down

Testing

Backend (Django):

Run backend tests with pytest:

cd dailynotes_api
pytest

Frontend (React):

Run frontend tests with npm:

cd dailynotes-ui
npm test

API Endpoints

Method Endpoint Description
POST /api/auth/login Log in a user
GET /api/notes/ Retrieve all notes
POST /api/notes/ Create a new note
PUT /api/notes/<id> Update an existing note
DELETE /api/notes/<id> Delete a note

Environment Variables

Backend (dailynotes_api):

Create a .env file in the dailynotes_api directory with the following:

SECRET_KEY=your-secret-key
DEBUG=True
ALLOWED_HOSTS=localhost,127.0.0.1

Frontend (dailynotes-ui):

Create a .env file in the dailynotes-ui directory with the following:

REACT_APP_BACKEND_URL=http://localhost:8000