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

Restructure the README in membrane-backend #83

Open k-allagbe opened 10 months ago

k-allagbe commented 10 months ago

Currently the README is confusing. We should break it down into separate docs to have a short and clean README.md.

Suggested structure:

  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