datamays.com

Personal portfolio and data engineering showcase site.

This repository hosts the code for datamays.com, built with Django, Tailwind, and other supporting tools. The project uses uv for Python dependency management and a VS Code Dev Container for a consistent development environment.

Feel free to fork and use as a foundation for your own personal portfolio!

---

Table of Contents

• Requirements
• Getting Started
• Running the Project Locally
• Adding Dependencies
• Contributing

---

Requirements

• Docker (for dev container)
• VS Code
• VS Code Remote - Containers extension

Optionally, you can run without the dev container, but using the container ensures consistent versions of Python, Node, and dependencies.

---

Getting Started

1. Clone the repository:

git clone https://github.com/dimays/datamays.git
cd datamays

2. Open the repo in VS Code and reopen in the dev container:

Command Palette → "Dev Containers: Reopen in Container"

3. Post-create setup:

The dev container automatically runs .devcontainer/post-create.sh, which will:

• Install Node.js dependencies (npm install)
• Sync Python dependencies using uv (uv sync → generates .venv)

You should see .venv/ created and uv.lock generated if it doesn’t exist yet.

---

Running the Project Locally

Django Server

uv run python manage.py runserver 0.0.0.0:8000

Visit http://localhost:8000 in your browser.

Tailwind / Frontend Dev Server

npm run dev

Visit http://localhost:3000 for Tailwind hot-reload.

---

Adding / Updating Dependencies

Python Packages

• Add a package:

uv add <package-name>

• Remove a package:

uv remove <package-name>

• Sync dependencies and update .venv:

uv sync

All Python dependencies are defined in pyproject.toml and locked in uv.lock.

Node Packages

npm install <package-name>
npm remove <package-name>

---

Contributing

1. Fork the repository and create a branch for your feature/fix:

git checkout -b feature/my-new-feature

2. Make changes in the dev container to ensure environment consistency.
3. Test your changes locally.
4. Commit changes and push to your fork:

git add .
git commit -m "Add feature XYZ"
git push origin feature/my-new-feature

5. Open a Pull Request against main.

All commits should follow standard formatting and pass any pre-commit checks if configured.

---

Notes

• The dev container ensures that Python, Node, and other tooling are consistent across developers and CI/CD.
• .venv should not be committed. Only pyproject.toml and uv.lock should be tracked.
• Docker + VS Code Dev Containers are strongly recommended for first-time setup.