Updates to README and initial project setup (#552)

* Redirect to api/v2

* Update README, fix code formatting

docs: update instructions about pre-commit and backend dependencies

fix: make homepage redirect a temporary redirect because the API version will change

* Use urljoin

* fix: keep name of route for home page

* fix: ui configuration in compose stack

---------

Co-authored-by: Michael Bunsen <notbot@gmail.com>

Author: vanessavmac

README.md

@@ -17,6 +17,16 @@ The platform uses Docker Compose to run all services locally for development. In
 
 ## Development
 
+Install the pre-commit tool to run linting & formatting checks _before_ each git commit. It's typical to install this tool using your system-wide python.
+
+```
+pip install pre-commit  # Install pre-commit system-wide
+pre-commit install  # Install the hook for our project
+```
+
+If using VS Code, install the formatting extensions that are automatically suggested for the project (e.g. black). Format-on-save should be turned on by default from the project's vscode settings file.
+
+
 ### Frontend
 
 #### Dependencies
@@ -55,6 +65,13 @@ Visit http://localhost:3000/
 - [Docker](https://docs.docker.com/get-docker/)
 - [Docker Compose](https://docs.docker.com/compose/install/)
 
+All backend packages are installed in the docker containers, however for faster auto-completion and intellisense, you can install them on the host machine:
+
+```bash
+python -m venv venv
+source venv/bin/activate
+pip install -r requirements/local.txt
+```
 
 #### Helpful Commands
 

compose/local/ui/Dockerfile

@@ -1,10 +1,8 @@
 # Node version should always match the version in `ui/.nvmrc`
 FROM node:18
 WORKDIR /app
-USER node
 COPY package.json yarn.lock ./
 RUN yarn install
-COPY . .
 RUN ["git", "config", "--global", "--add", "safe.directory", "/app"]
 ENV BROWSER=none
 CMD ["yarn", "start", "--host", "0.0.0.0" , "--port", "4000"]

config/urls.py

@@ -1,15 +1,19 @@
+from urllib.parse import urljoin
+
 from django.conf import settings
 from django.conf.urls.static import static
 from django.contrib import admin
 from django.contrib.staticfiles.urls import staticfiles_urlpatterns
 from django.urls import include, path
 from django.views import defaults as default_views
-from django.views.generic import TemplateView
+from django.views.generic import RedirectView
 from drf_spectacular.views import SpectacularAPIView, SpectacularSwaggerView
 
+API_ROOT = "api/v2/"
+
 urlpatterns = [
-    path("", TemplateView.as_view(template_name="pages/home.html"), name="home"),
-    path("about/", TemplateView.as_view(template_name="pages/about.html"), name="about"),
+    # Redirect homepage to API_ROOT
+    path("", RedirectView.as_view(url=API_ROOT, permanent=False), name="home"),
     # Django Admin, use {% url 'admin:index' %}
     path(settings.ADMIN_URL, admin.site.urls),
     # Your stuff: custom urls includes go here
@@ -21,11 +25,11 @@
 # API URLS
 urlpatterns += [
     # API base url
-    path("api/v2/", include("config.api_router", namespace="api")),
+    path(API_ROOT, include("config.api_router", namespace="api")),
     # OpenAPI Docs
-    path("api/v2/schema/", SpectacularAPIView.as_view(api_version="api"), name="api-schema"),
+    path(urljoin(API_ROOT, "schema/"), SpectacularAPIView.as_view(api_version="api"), name="api-schema"),
     path(
-        "api/v2/docs/",
+        urljoin(API_ROOT, "docs/"),
         SpectacularSwaggerView.as_view(url_name="api-schema"),
         name="api-docs",
     ),

docker-compose.yml

@@ -43,22 +43,21 @@ services:
     env_file:
       - ./.envs/.local/.postgres
 
-  # ui:
-  #   image: ami_local_ui
-  #   build:
-  #     context: ./ui
-  #     dockerfile: ../compose/local/ui/Dockerfile
-  #   ports:
-  #     - "4000:4000"
-  #   volumes:
-  #     - ./.git:/app/.git:ro
-  #     - ./ui:/app
-  #     - /app/node_modules
-  #   depends_on:
-  #     - django
-  #   environment:
-  #     - CHOKIDAR_USEPOLLING=true
-  #     - API_PROXY_TARGET=http://django:8000
+  ui:
+    image: ami_local_ui
+    build:
+      context: ./ui
+      dockerfile: ../compose/local/ui/Dockerfile
+    ports:
+      - "4000:4000"
+    volumes:
+      - ./.git:/app/.git:ro
+      - ./ui:/app
+    depends_on:
+      - django
+    environment:
+      - CHOKIDAR_USEPOLLING=true
+      - API_PROXY_TARGET=http://django:8000
 
   docs:
     image: ami_local_docs