Are there any instructions for local dev?

[Schachte]

I'm trying to run locally and am getting hit with AWS env issues. Is there a local version that uses disk or in-memory filesystem without reliance on S3?

[aalemayhu]

@Schachte sorry for replying to you so late. I just so your message now.

The AWS errors are due to the current requirement of needing to use DigitalOcean spaces. I plan on removing this from the bootstraping process. It's just implementation detail. In the past we experienced running out of disk space several times since anyone in the world could upload files.

[cjappl]

I am wondering the same thing (but at a more basic level).

If I want to bring up the code to make changes locally to help contribute, how do I get started? How do I spin up a local server, or any unit tests? Where do I find additional info?

Thank you!

[aalemayhu]

The plan is to have excellent documentation on this and it will be part of the self-hosting section https://docs.2anki.net/advanced/self-hosting/

Unfortuntately I have not gotten around to writing it. I will add a comment here when I get to it but of course you are very welcome to contribute to the new documentation and I can help you https://github.com/2anki/docs.2anki.net

[cjappl]

Would love to help put together an initial draft. What is the correct venue to ask clarifying questions?

Specifically right now i have run the server:

npm run dev

And attempted a curl command, with the request that is sent to the website:

curl 'http://localhost:2020/api/upload/file' -H 'Accept-Encoding: gzip, deflate, br' -H 'Referer: https://2anki.net/' -H 'Origin: http://localhost:2020' -H 'DNT: 1' -H 'Connection: keep-alive' -H 'Sec-Fetch-Dest: empty' -H 'Sec-Fetch-Mode: cors' -H 'Sec-Fetch-Site: same-origin' --data-binary '-----------------------------294571773434853366911622843556\r\nContent-Disposition: form-data; name="pakker"; filename="/Users/topher/code/server/NOTION.zip"\r\nContent-Type: application/zip\r\n\r\n-----------------------------294571773434853366911622843556\r\nContent-Disposition: form-data; name="reversed"\r\n\r\nfalse\r\n-----------------------------294571773434853366911622843556\r\nContent-Disposition: form-data; name="bugsnag-anonymous-id"\r\n\r\nclvmyf39r00002e6e02o6fzs2\r\n-----------------------------294571773434853366911622843556\r\nContent-Disposition: form-data; name="use-notion-id"\r\n\r\ntrue\r\n-----------------------------294571773434853366911622843556\r\nContent-Disposition: form-data; name="perserve-newlines"\r\n\r\ntrue\r\n-----------------------------294571773434853366911622843556\r\nContent-Disposition: form-data; name="basic-reversed"\r\n\r\nfalse\r\n-----------------------------294571773434853366911622843556\r\nContent-Disposition: form-data; name="add-notion-link"\r\n\r\nfalse\r\n-----------------------------294571773434853366911622843556\r\nContent-Disposition: form-data; name="enable-input"\r\n\r\nfalse\r\n-----------------------------294571773434853366911622843556\r\nContent-Disposition: form-data; name="deckName"\r\n\r\nDSP Notion\r\n-----------------------------294571773434853366911622843556\r\nContent-Disposition: form-data; name="tags"\r\n\r\nfalse\r\n-----------------------------294571773434853366911622843556\r\nContent-Disposition: form-data; name="paragraph"\r\n\r\nfalse\r\n-----------------------------294571773434853366911622843556\r\nContent-Disposition: form-data; name="cherry"\r\n\r\nfalse\r\n----
-------------------------294571773434853366911622843556\r\nContent-Disposition: form-data; name="all"\r\n\r\ntrue\r\n-----------------------------294571773434853366911622843556\r\nContent-Disposition: form-data; name="cloze"\r\n\r\ntrue\r\n-----------------------------294571773434853366911622843556\r\nContent-Disposition: form-data; name="remove-mp3-links"\r\n\r\ntrue\r\n-----------------------------294571773434853366911622843556\r\nContent-Disposition: form-data; name="avocado"\r\n\r\ntrue\r\n-----------------------------294571773434853366911622843556\r\nContent-Disposition: form-data; name="max-one-toggle-per-card"\r\n\r\ntrue\r\n-----------------------------294571773434853366911622843556\r\nContent-Disposition: form-data; name="no-underline"\r\n\r\nfalse\r\n-----------------------------294571773434853366911622843556--\r\n'

And I get the error:

TypeError: files is not iterable
    at GeneratePackagesUseCase.<anonymous> (/Users/topher/code/server/src/usecases/uploads/GeneratePackagesUseCase.ts:85:24)
    at Generator.next (<anonymous>)
    at /Users/topher/code/server/src/usecases/uploads/GeneratePackagesUseCase.ts:8:71
    at new Promise (<anonymous>)
    at __awaiter (/Users/topher/code/server/src/usecases/uploads/GeneratePackagesUseCase.ts:4:12)
    at GeneratePackagesUseCase.execute (/Users/topher/code/server/src/usecases/uploads/GeneratePackagesUseCase.ts:62:16)
    at UploadService.<anonymous> (/Users/topher/code/server/src/services/UploadService.ts:37:42)
    at Generator.next (<anonymous>)
    at /Users/topher/code/server/src/services/UploadService.ts:31:71
    at new Promise (<anonymous>)

[aalemayhu]

You can ask questions here or email me directly ([email protected]). I am open to helping you over a live call as well.

I am not sure why the curl call is failing but I usually work via running both the frontend and backend locally. Have you also cloned the frontend code into /Users/topher/code/web and built it ? When you run it it should be available on http://localhost:3000/

[aalemayhu]

https://docs.2anki.net/advanced/self-hosting/