Resources and Plan

Resources and Plan

1. People

1. Berker Parlaker: developer (requirements, design, coding, testing and deployment)
2. Course instructor (@uskudarli): reviewer and stakeholder, gives feedback on milestones

2. Time

• Project period: early October until the end of November or early December.
• Planned effort: about 8-10 hours per week.

3. Tools and technologies

1. Python and Django for the web application. Django has a built-in login system and admin panel, and there are many tutorials.
2. PostgreSQL as the database (SQLite while developing). It is free and works well with Django.
3. Django templates and Bootstrap for the pages. Responsive layout without much CSS.
4. Leaflet and OpenStreetMap for the map. Free, no API key needed.
5. Local media folder for images at first, cloud storage later if needed.
6. Docker and docker-compose so the setup is the same on every computer.
7. Render (free tier) for hosting. Same platform as the example site, deploys from GitHub.
8. GitHub for code and planning: repository, issues, labels, milestones and wiki.
9. VS Code as the editor.

4. Learning resources

• Django official tutorial: https://docs.djangoproject.com/en/stable/intro/tutorial01/
• Bootstrap documentation: https://getbootstrap.com/docs/
• Leaflet quick start: https://leafletjs.com/examples/quick-start/
• Deploying a Django app on Render: https://render.com/docs/deploy-django
• Pro Git book: https://git-scm.com/book

5. Milestones

5.1 Milestone 1: Requirements, Use Cases & Mockups (6 Oct - 13 Oct)

• Overview, requirements and requirement validation on the wiki
• Domain model with the Kilim example
• Use cases as text and diagrams, user stories
• Mockups of 3 screens

5.2 Milestone 2: Initial Prototype (14 Oct - 20 Oct)

• Django project running in Docker
• Sign up and log in (US-01)
• Add a Kilim entry with units, colors, patterns (US-02) and a map pin (US-03)
• Entry detail page (US-04)
• Deployed on Render

The next milestones will be planned after the prototype. Every issue belongs to one milestone; see the milestones page.

6. Risks and what I will do

1. I am new to Django, so things may take longer than planned. I will start with the official tutorial and leave the "Could" requirements to the end.
2. Free hosting has limits (the app sleeps when idle, the database is small). I will deploy early, in Milestone 2, so problems show up early.
3. Image uploads or storage may cause problems on the host. I will start with small images and move to cloud storage only if needed.
4. Running out of time near the deadline. Must-have features come first.