Skip to content

Latest commit

 

History

History
90 lines (58 loc) · 3.56 KB

README.md

File metadata and controls

90 lines (58 loc) · 3.56 KB
Raw

Agent

tested with jest

Collaborate together in a value network.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

nd. Agent consumes data from 2 possible endpoints, both used in the faircoop ecosystem. If you want to install Agent locally and you're not part of faircoop, you need to install also the backend locally

Prerequisites

You need nodejs and npm installed on your machine. The app heavily uses the OCE KIT as design system and component library, the kit is not published as npm module yet (need some refinements and an acceptable testing coverage). If you want to have a local version of Agent app on your machine, you need to clone the kit repository, build it and npm link it on agent folder.

git clone [email protected]:opencooperativeecosystem/kit.git
cd kit
npm run build
npm link

Run Agent on your machine locally

Agent is an ejected version of CRA - Create react app - project. In order to have a local version of Agent running on your machine you will need to follow these steps:

git clone [email protected]:opencooperativeecosystem/agent.git
cd agent
npm install
npm link kit
npm start

Running the tests

The test suite is made with Puppeeter and Jest. Currently the app is covered only with End to End tests. We will cover the app also with unit tests.

To run the tests:

npm run debug

Deployment

Agent is a static app, therefore deployment is quite straightforward. You mainly need to build your app.

npm run build

The resultant artifact contains the static files that will interact with the graphQl layer, you can deploy the folder with github-pages, zeit or any (serverless, or classic) hosting service.

The fair.coop Agent version is deployed with Zeit <3

Built With

  • React - The web framework used
  • Apollo - Both to manage graphql on the server and as local state management
  • post-css - Transforming styles with JS plugins // planned to move to styled-components
  • webpack - Javascript bundler

Contributing

[TODO]

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Docs

You can read more about Agent and OCE on our website and docs

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the AGPL 3.0 License

Acknowledgments

  • Mikorizal (Lynn Foster and Bob Haugen) - to have built the NRP software and keep working hard to foster the transition to the next economy, and for being a costant source of inspiration.
  • FairCoop - to experiment with practice together