I465 Adding django backend #492

pushyamig · 2025-01-14T14:53:04Z

Fixes #465

This PR is

Adding Django Backend
Removing all the NodeJS Backend packages from package.json.
Doing the Webpack build from only React code
Using docker Supervisor feature for running FE and BE
README instruction are there. Simply only doing docker compose build and docker compose up
.env file in not place in the project root directory instead in the ${HOME}/secrets/ccm/.env. So create folder /secrets/ccm

The CCM homepage will launch, but for now I added dummy data for the API call when the home page launches. This setup is going to be temporary until be have API integration happens. All the changes can be found in api.ts

This PR does not have

LTI integration, which is next
I haven't setup DockerBuild for running in Prod mode, which I will pause and will look when doing the Openshift setup
You might see a warning saying
ExperimentalWarning: --experimental-loader may be removed in the future; instead use register()
That is because CCM migrated to ESM and not commonJS. So in future version of Node commonJS support might be removed.
node --loader ts-node/esm node_modules/.bin/webpack --config webpack/webpack.dev.ts --watch
4. More On this can be found here. This is something know during ##330 Upgrade CCM To ESM #433
I did not remove the NodeJS code w.r.t to BE which is in server. I will remove it in future.

jonespm · 2025-01-14T16:49:34Z

requirements.txt

+mysqlclient==2.2.6
+
+#Django
+Django==5.1.4


Django 5.1 isn't LTS, 5.2 LTS doesn't come out until April. You may want to hold back to Django 4.2 (currently 4.2.18) until later this year unless this isn't going to be released until after April 2025.

I feel Releasing in Apr is very optimistic. I feel this is going to live in summer. Thats why I chose Django 5 version. I can change to 4 version if you like. LMK

I think it's fine based on the release timeline here to leave it 5.1, just that we should update to Django 5.2 before we do release. It should be out in early April. I think this is good progress and we might have this by late April or May.

I will keep 5.1 and will upgrade to 5.2 before release. I will create an issue for that.

jonespm · 2025-01-14T16:50:10Z

requirements.txt

+django-mysql==4.15.0
+django-webpack-loader==3.1.1  
+
+debugpy==1.8.8


This should be updated to 1.8.11, also might want to check the versions of the other dependencies here?

jonespm · 2025-01-14T16:52:24Z

README.md

-using fallbacks when available and throwing an error if required values are not present.
-The application will exit if any of the required configuration values are not set properly.
-
-#### Canvas


I think much of this section is still relevant. Might want to break it out the parts that won't change into separate .MD files to make it easier to maintain separately like we did for MyLA in docs.

Yes, but I want to add stuff, based on the implementation. So I did not implement the LTI, Canvas Oauth. So I. removed it for making the PR reviewer just focus on what is there. I will add them back when I am adding features on at a time

jonespm · 2025-01-14T16:54:29Z

docker-compose.yml

    environment:
      - PORT=4000
-      - NODE_ENV=development
-    env_file: .env
+      - DEBUG=True


I found out with ROHQ that you can use this pattern to specify defaults in the docker-compose file

- DEBUG=${DEBUG:-True}

I'd switch to this here for everything in the environment section.

https://github.com/tl-its-umich-edu/remote-office-hours-queue/blob/e329460a143c18fdcaf3dbb24284879a30ebc9c2/docker-compose.yaml#L9

jonespm · 2025-01-14T16:54:40Z

docker-compose.yml

-      context: ./ccm_web/
-      dockerfile: ./Dockerfile
+      context: .
+      dockerfile: Dockerfile
      args:


I don't think the args are needed here anymore.

Thanks, Removed

jonespm

Approving but left a few comments which can be addressed now or in future issues if you just want to move this along. Thanks!

pushyamig · 2025-01-14T18:51:24Z

This PR Finishes #466,

jaydonkrooss · 2025-01-14T20:09:57Z

Looks good to me, locally ran it with 404 errors on the API, which I assume is expected. I can help with APIs once we move on to that step, just let me know.

pushyamig · 2025-01-14T20:23:58Z

Looks good to me, locally ran it with 404 errors on the API, which I assume is expected. I can help with APIs once we move on to that step, just let me know.

Yes, API endpoints are not wired up so those errors are expected. We are progressively building it. This PR is to separate the FE from the Node setup and build using on Webpack and make the Js Dump file main-*.js available via Django Setup. Along with that integrate with Django Ecosystem.

When CCM launch it makes API call, so I have to set up some static JSON response and launching the home page so that It acceptable for this PR.

pushyamig · 2025-01-14T20:25:06Z

Thanks @jonespm and @jaydonkrooss for the Quick Review.

pushyamig added 2 commits January 10, 2025 10:37

Adding the python gitignore content

3c98e5c

tl-its-umich-edu#465 Adding Django Backend and building FE with webpack

01369c9

pushyamig requested review from jaydonkrooss and jonespm January 14, 2025 14:53

pushyamig changed the title ~~I465 django be~~ I465 Adding django backend Jan 14, 2025

jonespm reviewed Jan 14, 2025

View reviewed changes

jonespm approved these changes Jan 14, 2025

View reviewed changes

pushyamig mentioned this pull request Jan 14, 2025

Upgrade to Django 5.2 #493

Open

466 FE fulling working

f76e363

pushyamig force-pushed the i465_Django_BE branch from e754993 to f76e363 Compare January 14, 2025 18:55

jaydonkrooss approved these changes Jan 14, 2025

View reviewed changes

pushyamig merged commit d0ab54f into tl-its-umich-edu:develop Jan 14, 2025
1 check failed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

I465 Adding django backend #492

I465 Adding django backend #492

pushyamig commented Jan 14, 2025 •

edited

Loading

jonespm Jan 14, 2025

pushyamig Jan 14, 2025

jonespm Jan 14, 2025 •

edited

Loading

pushyamig Jan 14, 2025

jonespm Jan 14, 2025

pushyamig Jan 14, 2025

pushyamig Jan 14, 2025

jonespm Jan 14, 2025

pushyamig Jan 14, 2025

jonespm Jan 14, 2025

pushyamig Jan 14, 2025

jonespm Jan 14, 2025

pushyamig Jan 14, 2025

jonespm left a comment

pushyamig commented Jan 14, 2025

jaydonkrooss commented Jan 14, 2025

pushyamig commented Jan 14, 2025

pushyamig commented Jan 14, 2025 •

edited

Loading

I465 Adding django backend #492

I465 Adding django backend #492

Conversation

pushyamig commented Jan 14, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jonespm Jan 14, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jonespm left a comment

Choose a reason for hiding this comment

pushyamig commented Jan 14, 2025

jaydonkrooss commented Jan 14, 2025

pushyamig commented Jan 14, 2025

pushyamig commented Jan 14, 2025 • edited Loading

pushyamig commented Jan 14, 2025 •

edited

Loading

jonespm Jan 14, 2025 •

edited

Loading

pushyamig commented Jan 14, 2025 •

edited

Loading