[chore] project set up docs

[supun-io]

Currently, https://github.com/hyvor/dev README is great to set up the projects, but each project has its own way to run migrations and to set up the ENV (in Laravel, Symfony has .env.dev)

FOR EACH PROJECT (see the table here),

• Add a "Contributing" section in the README.md (see https://github.com/hyvor/post?tab=readme-ov-file#contributing)
• Make sure it has something similar to the following:
  • Setting up hyvor/dev and running it
  • Set up env (migrations, seeding, env file setup)
  • Directory structure

Example:

---

Contributing

Visit hyvor/dev to set up the HYVOR development environment. Then, run ./run post to start Hyvor Post at https://post.hyvor.localhost.

Then, run the following in the hyvor-post-backend container to run the migrations.

# reset the database, run migrations, and seed
bin/console app:dev:reset --seed

Directory structure:

/backend: Symfony API backend
/frontend: SvelteKit frontend
/embed: Signup form embed code
/archive: Newsletter archive website

---

For laravel projects, since there is no .env.dev loading like Symfony, we have to add instructions to copy the .env.dev file.

• Create an .env.dev file and make sure it works with dev config (database, etc.). Currently, most of our Laravel projects are missing this, and it is a pain to set up a new environment. Note that some config may already be there in .env.example. We'll keep .env.example as the source of truth, and .env.dev as the ENV variables for DEV env
• Update Contributing section in README to include copying the .env file (cp talk/backend/.env.dev talk/backend.env). Make sure to test it works.

Important:

• To work on this issue, take a fresh copy from hyvor/dev and make each project work. We want to document and automate setting up the DEV env for anyone who sets up a fresh repo.