Virtual office of somenergia's representation service
- python>=3.10
- make
- node>=20.4.0
- libcairo-dev
Early versions could work but not tested.
If you system default Python do not meet python requirements, the recommended path is to use pyenv to install the required version and activate it local in the project directory before installing dependencies.
pyenv install 3.10
pyenv local 3.10make deps # Installs dependencies (for python creates the virtual environment if missing)make tests # Pass ui and api testsWhile in a test driven session you can run test in auto reload mode. But you have to run ui and api tests separatelly.
make ui-test
make api-testBackend Config. Copy .env-example as .env and edit.
Frontend Config: Defaults in frontend/.env can be overriden
by copying frontend/.env.local-example as frontend/.env.local and editing it.
# In diferent consoles:
make ui-dev # runs the frontend server at localhost:5173
make api-dev # runs the backend server at localhost:5500- In development, the frontend proxies the backend.
- In producction, the backend serves the compiled frontend in
backend/dist.
TODO: Unify both environments, by achieving hot module reload
while generating in backend/dist for the backend to serve in development.
representa-manage is a installed script which includes, as subcommands, some utilities for operation and development.
Some of them are:
- reset-password: resets the password of a user
- list-signatures: removes the signatures made by a user
- clear-signatures: removes the signatures made by a user
See the command help for more information.
WARNING! The directoy backend/dist should exist in order to run the scripts (if it does not, create it :D )
git fetchto get the latest updatestig --allto see deployed and incoming versiongit rebase- Review CHANGES.md for Upgrade Notes (since last deployed version)
make deployInstall ui/api dependencies and build uisudo supervisor restart