Collaborate together in a value network.
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
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 firstname.lastname@example.org: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@example.com:opencooperativeecosystem/agent.git cd agent npm install npm link kit npm start
Running the tests
To run the tests:
npm run debug
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
- 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
See also the list of contributors who participated in this project.
This project is licensed under the AGPL 3.0 License