Discussion: Local Project Setup

[Pdzly]

I am about to try to develop some minor things to WSD, and it would be good to know what i need to setup.

What i already found out:

1. Database ( just copy the dockercompose part out of the docker-compose )
2. Install all deps on backend and frontend. ( Frontend install it with npn install --legacy-peer-deps because a dependency requires a different react than installed )
3. Create a .env.local with the given ENVs ( see Dockerfile, one thing i am unsure about is, the auth api endpoint where it should point on local env )
4. Theoretically "done" and now just need to start it with npm run dev and backend i am not sure how to start it.

I did not try it out fully but if anyone can let me know if there is anything else to be done before starting it.

[isik-kaplan]

Yeah there are some questionable choices I've made baked-in to the docker compose and to the config. Even if you set all the env vars to reasonable values not everything would work as I define some of them separately for front-end and back-end for weird reasons like trying to make the docker-compose work for both prod and local development (I should've just separated them instead of insisting on a single docker compose like a stubborn child lmao)

Also to get everything working properly you may need to setup some hosts file entries so you don't get caught on localhost restrictions.

I'll add a local-development.md doc to describe everything you need to setup for everything to work correctly.

I'll include a docker version and a local version (which might be slightly more involved)

I'll also add an example .env file that's ready to just work with docker compose locally.

But yeah, with some extra quirks I introduced, what you described is pretty much correct.

[Pdzly]

Ahh ok. Thanks a lot!

@isik-kaplan One more question i have is there like a developer discord? or similar? or only github issues for communication?

[isik-kaplan]

There isn't a dedicated server for it but I'm active in the unofficial django server and since it is django I guess we can chat there?

https://discord.gg/azRjQfvGfX this is the link for it if I didn't mess something up somehow

But I'd prefer to keep most technical stuff here in the issues so in case this gets a bit bigger other folks can browse the issues to see what's happening and get help from the issues

[Pdzly]

Yeah i guess that is true. But maybe in the future for non technical stuff or real minor technical stuff/little questions, have a discord ( but far in the future, when it is bigger )

[isik-kaplan]

Hey, I just pushed this half-baked instructions that should be able to get anyone on linux started 575fc72 but it only works on linux

On apple silicon the ml model doesn't play nicely, on windows docker compose can't detect wsd:latest is a local image and not a remove one and I was too lazy to rewrite the compose file

Also the compose still assumes this is mostly for production and therefore builds the next frontend instead of running dev. But the whole thing should give you enough of an idea on how to run everything locally.

Do let me know if this isn't enough or doesn't work for you or if you see anything that doesn't work on linux and we can reopen this issue and I can try to be more helpful

[Pdzly]

@isik-kaplan perfect i am on linux too so thats perfect.

[Pdzly]

Couldnt those hosts entries be simply replaced by using "extra-hosts" docker compose entries?

[isik-kaplan]

The hosts file change is not really for routing stuff inside containers (I did that with container aliases instead), it is to get around cookie restrictions on localhost domain when you are interacting with the website from the browser. The backend supports both cookie and token auth (from some library) but I opted for cookies on web side (still need the token for the mobile app when I start writing one) to make things easier.

I believe by spec localhost acts weird. You can't set cookies on localhost by explicitly giving localhost as the domain since it is not really a "domain" you omit the domain in the header to set to localhost, this means that you can't set domains on .localhost to say all subdomains of localhost should be able to get this cookie. (Apparently there are some workarounds for this like using {something}.localhost e.g. app.localhost as your domain so you can set cookies to .app.localhost but I haven't tried it and it would make existing subdomains look like api.app.localhost which may require app code change just to accommodate local development) Everything assumes the app is mounted at top level domain.

I guess we can test app.localhost to see if it works but I suspect it may cause unseen problems and just cause Michigan J. Frog bugs around the authentication system. Do you think it is a bit much to ask people to change their host machine hosts file?

[Pdzly]

It works partially, i can go to the website and "seemingly" register but i cant login.
Update: I can login but i can not go to the website ever and it only returns 504

There are some errors occuring like

[Pdzly]

After waiting few minutes it got back but logged out.

[isik-kaplan]

If it is what I'm thinking this is totally on me, sorry! I forgot the git lfs step for people who do not have git-lfs installed. There is a model file wsd/apps/core/utils/nsfw_detector/nsfw.299x299.h5 which is added via git lfs.

Can you check the file? Either file --mime wsd/apps/core/utils/nsfw_detector/nsfw.299x299.h5 or head -n 3 wsd/apps/core/utils/nsfw_detector/nsfw.299x299.h5 and if it is a text file you just need to pull it with git lfs pull after installing git lfs.

Let's see if this resolves the issue, it might be that backend container keeps restarting due the same issue (also loads the model) so backend is never fully up and running and front-end container just gets errors from it hence just says you are not authenticated.

[Pdzly]

Ok with that i can now start, login with the default admin account, registration still fails ( probably because email )

[isik-kaplan]

The emails needs to be verified, I guess we can change that behavior on debug mode. The emails are sent to stdout though so you should see the emails that are sent for verification purposes and if you copy from the terminal to browser and then just click verify I think that should work too. (I assume you mean you can't login after registering, does the act of creating a new account fail? If so that might be a different bug)