Initial Setup for Secret Notes Project with Docker, Django, and Kubernetes

.flake8

@@ -0,0 +1,9 @@
+[flake8]
+exclude = 
+    migrations,
+    __pycache__,
+    manage.py,
+    settings.py,
+    env
+max-line-length = 88
+extend-ignore = E203

.github/workflows/ci.yaml

@@ -0,0 +1,43 @@
+name: CI
+
+on:
+  push:
+    branches: [main, development]
+  pull_request:
+    branches: [main]
+
+jobs:
+  format:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install black
+      - name: Run formatting check
+        run: black --check .
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+      - name: Run tests
+        env:
+          DJANGO_SETTINGS_MODULE: secret_notes_project.test_settings
+        run: |
+          python manage.py test
+          python manage.py test notes.integration_tests
+          python manage.py test notes.e2e_tests

.gitignore

@@ -129,6 +129,7 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+.vscode
 
 # Spyder project settings
 .spyderproject

Dockerfile

@@ -0,0 +1,20 @@
+FROM python:3.10-alpine
+
+ENV PYTHONDONTWRITEBYTECODE=1
+ENV PYTHONUNBUFFERED=1
+
+WORKDIR /app
+
+RUN apk add --no-cache gcc musl-dev
+
+COPY requirements.txt .
+RUN pip install --upgrade pip && pip install --no-cache-dir -r requirements.txt
+
+COPY . .
+
+RUN python manage.py collectstatic --noinput
+
+COPY wait_for_db.sh /wait_for_db.sh
+RUN chmod +x /wait_for_db.sh
+
+CMD sh -c "/wait_for_db.sh && python manage.py migrate && python manage.py collectstatic --noinput && exec gunicorn secret_notes_project.wsgi:application --bind 0.0.0.0:8008"

README.md

@@ -1 +1,120 @@
-# SecretNote-MVC-MohamedFadel
+# Secret Notes Project
+
+Secret Notes is a Django-based web application that allows users to create and share secure, self-destructing notes. The project is containerized using Docker and can be easily deployed using Docker Compose or Kubernetes.
+
+## Features
+
+- Create secure, encrypted notes
+- Set expiration time for notes
+- View notes using unique URL keys
+- User registration and authentication
+- Rate limiting to prevent abuse
+- Dockerized application for easy deployment
+
+## Prerequisites
+
+- Docker and Docker Compose
+- Kubernetes (optional, for k8s deployment)
+
+## Quick Start
+
+1. Clone the repository:
+
+   ```
+   git clone https://github.com/codescalersinternships/SecretNote-MVC-MohamedFadel/tree/development
+   cd SecretNote-MVC-MohamedFadel
+   ```
+
+2. Start the application using Docker Compose:
+
+   ```
+   docker-compose up --build
+   ```
+
+3. Access the application at `http://localhost:8008`
+
+## Project Structure
+
+```
+.
+├── docker-compose.yaml
+├── Dockerfile
+├── manage.py
+├── notes/                 # Main application
+├── README.md
+├── requirements.txt
+├── secret-note/           # Helm chart for Kubernetes deployment
+├── secret_notes_project/  # Django project settings
+├── staticfiles/
+└── wait_for_db.sh
+```
+
+## Development
+
+To set up the development environment:
+
+1. Create a virtual environment:
+
+   ```
+   python -m venv venv
+   source venv/bin/activate
+   ```
+
+2. Install dependencies:
+
+   ```
+   pip install -r requirements.txt
+   ```
+
+3. Run migrations:
+
+   ```
+   python manage.py migrate
+   ```
+
+4. Start the development server:
+   ```
+   python manage.py runserver
+   ```
+
+## Testing
+
+The project includes various test files:
+
+- `notes/tests.py`: Unit tests
+- `notes/integration_tests.py`: Integration tests
+- `notes/e2e_tests.py`: End-to-end tests
+
+To run the tests:
+
+```
+python manage.py test
+```
+
+## Deployment
+
+### Docker Compose
+
+Use the provided `docker-compose.yaml` file to deploy the application:
+
+```
+docker-compose up --build
+```
+
+### Kubernetes
+
+A Helm chart is provided in the `secret-note` directory for Kubernetes deployment. To deploy using Helm:
+
+1. Install Helm (if not already installed)
+2. From the project root, run:
+   ```
+   helm install secret-notes ./secret-note
+   ```
+
+## Configuration
+
+The main configuration files are:
+
+- `secret_notes_project/settings.py`: Django settings
+- `docker-compose.yaml`: Docker Compose configuration
+- `secret-note/values.yaml`: Helm chart values for Kubernetes deployment

docker-compose.yaml

@@ -0,0 +1,32 @@
+services:
+  secret-note-db:
+    image: postgres
+    volumes:
+      - ./data/secret-note-db:/var/lib/postgresql/data
+    environment:
+      - POSTGRES_DB=secretnote
+      - POSTGRES_USER=secretnote
+      - POSTGRES_PASSWORD=secretnote
+      - POSTGRES_HOST=secret-note-db
+      - POSTGRES_PORT=5432
+      - DATABASE_URL=postgres://secretnote:secretnote@secret-note-db:5432/secretnote
+
+  web:
+    build: .
+    command: >
+      sh -c "until nc -z secret-note-db 5432; do echo waiting for secret-note-db; sleep 1; done &&
+              python manage.py migrate &&
+              python manage.py collectstatic --noinput &&
+              gunicorn secret_notes_project.wsgi:application --bind 0.0.0.0:8008"
+    volumes:
+      - .:/app
+    ports:
+      - "8008:8008"
+    environment:
+      - DATABASE_URL=postgres://secretnote:secretnote@secret-note-db:5432/secretnote
+      - DEBUG=False
+    depends_on:
+      - secret-note-db
+
+volumes:
+  static_volume:

manage.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "secret_notes_project.settings")
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == "__main__":
+    main()

notes/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class NotesConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "notes"