Skip to content
/ README Public template
forked from puria/README

๐Ÿ“ README.md template to facilitate new projects documentation

Notifications You must be signed in to change notification settings

interfacerproject/README

ย 
ย 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

19 Commits
ย 
ย 

Repository files navigation

{project_name}

{tagline}

Building the digital infrastructure for Fab Cities


Interfacer project

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

{project_name} Features

{screenshot}



๐Ÿ’พ Install

pip install / yard add {project_name}

๐Ÿ” back to top


๐ŸŽฎ Quick start

To start using {project_name} run the following command in the root folder

docker compose up

๐Ÿ” back to top


๐Ÿ‹ Docker

Please refer to DOCKER PACKAGES

๐Ÿ” back to top


๐Ÿ API

Available endpoints

POST /token

Execute a transaction with some amount

Parameters

Name Required Type Description
token required string Type of token. Accepted values idea or strength
amount required number Transaction's token amount
owner required ULID The ULID of the Agent's owner

GET /token/${request.token}/${request.owner}

Retrieves the actual value of the token type for the specified owner

๐Ÿ” back to top


๐Ÿ”ง Configuration

๐Ÿ” back to top


๐Ÿ“‹ Testing

๐Ÿ” back to top


๐Ÿ› Troubleshooting & debugging

๐Ÿ” back to top


๐Ÿ˜ Acknowledgements

Copyleft (ษ”) 2022 by Dyne.org foundation, Amsterdam

Designed, written and maintained by Puria Nafisi Azizi.

Special thanks to Mr. W. White for his special contributions.

๐Ÿ” back to top


๐ŸŒ Links

https://www.interfacer.eu/

https://dyne.org/

๐Ÿ” back to top


๐Ÿ‘ค Contributing

  1. ๐Ÿ”€ FORK IT
  2. Create your feature branch git checkout -b feature/branch
  3. Commit your changes git commit -am 'Add some fooBar'
  4. Push to the branch git push origin feature/branch
  5. Create a new Pull Request
  6. ๐Ÿ™ Thank you

๐Ÿ” back to top


๐Ÿ’ผ License

{project_name} - {tagline}
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/>.

๐Ÿ” back to top

About

๐Ÿ“ README.md template to facilitate new projects documentation

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published