[](https://dashboard.cypress.io/projects/nqct2i/runs)
Building the digital infrastructure for Fab Cities
What is INTERFACER?
The goal of the INTERFACER project is to build the open-source digital infrastructure for Fab Cities.
Our vision is to promote a green, resilient, and digitally-based mode of production and consumption that enables the greatest possible sovereignty, empowerment and participation of citizens all over the world. We want to help Fab Cities to produce everything they consume by 2054 on the basis of collaboratively developed and globally shared data in the commons.
To know more DOWNLOAD THE WHITEPAPER
Interfacer GUI Features
{screenshot}
LIVE DEMO
๐ฎ Quick start
To start using Interfacer GUI run the following commands
docker pull ghcr.io/interfacerproject/interfacer-gui:main
docker run -it -p 3000:3000 ghcr.io/interfacerproject/interfacer-gui:mainOpen http://localhost:3000 with your browser to see the result.
๐พ Install
git submodule update --init
# then install the dependencies
pnpm i
# copy and fill the env variables from the example provided
cp .env.example .env.local
# to run the software slower but with livereload and watch
pnpm dev
# or build & start it for faster execution
pnpm build
pnpm startOpen http://localhost:3000 with your browser to see the result.
๐ Docker
docker pull ghcr.io/interfacerproject/interfacer-gui:main๐ง Configuration
Default values are available on the .env.example of this repository.
- DEEPL_API_KEY Deepl key api used in i18n module for auto-translation
- BASE_URL the federated instance of the gateway
- NEXT_PUBLIC_LOSH_ID The LUID designated as the owner of the LOSH imported assets
- NEXT_PUBLIC_ZENFLOWS_ADMIN The admin key of the federated zenflows instance
- NEXT_PUBLIC_INVITATION_KEY The invitation key needed to register new users
The next are derived services (endpoints of the instance microservice)
- NEXT_PUBLIC_ZENFLOWS_URL=$BASE_URL/zenflows/api
- NEXT_PUBLIC_ZENFLOWS_FILE_URL=$BASE_URL/zenflows/api/file
- NEXT_PUBLIC_LOCATION_AUTOCOMPLETE=$BASE_URL/location-autocomplete/
- NEXT_PUBLIC_LOCATION_LOOKUP=$BASE_URL/location-lookup/
- NEXT_PUBLIC_INBOX_SEND=$BASE_URL/inbox/send
- NEXT_PUBLIC_INBOX_READ=$BASE_URL/inbox/read
- NEXT_PUBLIC_INBOX_COUNT_UNREAD=$BASE_URL/inbox/count-unread
- NEXT_PUBLIC_INBOX_SET_READ=$BASE_URL/inbox/set-read
- NEXT_PUBLIC_WALLET=$BASE_URL/wallet/token
- NEXT_PUBLIC_SOCIAL=$BASE_URL/inbox/social
- NEXT_PUBLIC_SOCIAL_ECONOMIC_RESOURCE=$BASE_URL/inbox/economicresource
๐ Testing
E2E testing is provided via cypress.io and runnable locally via:
# in headless mode
pnpm test
# or by runnign cypress instance
pnpm e2e๐ก translations
pnpm translate
๐ Troubleshooting & debugging
Available bugs are reported in the Issues page
๐ Acknowledgements
Copyleft (ษ) 2022 by Dyne.org foundation, Amsterdam
Designed, written and maintained by Ennio Donato, Micol Salomone, Giovanni Abbatepaolo and Puria Nafisi Azizi.
๐ Links
๐ค Contributing
- ๐ FORK IT
- Create your feature branch
git checkout -b feature/branch - Commit your changes
git commit -am 'Add some fooBar' - Push to the branch
git push origin feature/branch - Create a new Pull Request
- ๐ Thank you
๐ผ License
Interfacer GUI - Interfacer's Progressive Web App client
Copyleft (ษ) 2022 Dyne.org foundation
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.