search

ai-cfia / membrane-backend

Membrane Backend: A centralized authentication service for Single Sign-On (SSO) enabling seamless token-based email verification across multiple client applications.
MIT License
1 stars 0 forks source link

Fixes #53 : Update the readme to reflect the use of devcontainer #82

Closed vivalareda closed 10 months ago

vivalareda commented 10 months ago

Fixes #53

rngadam commented 10 months ago

I would suggest to restructure the README like this:

  1. Setting up the development environment

    • Using devcontainer (already setup in devcontainer.json, all the developer needs to do is open the project in the devcontainer)
    • Using virtual environment (I would suggest here to link to an external guide as this is well known already)
  2. Environment variable configuration
  3. Running the app locally
  4. Running the app from dockerfile

@k-allagbe These details should be in the issue #83

k-allagbe commented 10 months ago

I would suggest to restructure the README like this:

  1. Setting up the development environment

    • Using devcontainer (already setup in devcontainer.json, all the developer needs to do is open the project in the devcontainer)
    • Using virtual environment (I would suggest here to link to an external guide as this is well known already)
  2. Environment variable configuration
  3. Running the app locally
  4. Running the app from dockerfile

@k-allagbe These details should be in the issue #83

Done