Ethlance Version 2 is Currently in Development and is subject to change before final release
- Node.js >= 16.15.1
- Java JDK >= 18 (for Clojure)
- Babashka
- PostgreSQL (tested with 14.6)
- IPFS daemon
- Ethereum testnet (e.g. ganache)
- Start IPFS
- Start ganache
- Migrate Solidity contracts to testnet:
npx truffle migrate --network ganache --reset - Start server build
bb watch-server - Start server (to serve the API)
bb run-server - Start UI build
bb watch-ui
- this also starts serving the UI assets & smart contract assets on port
6500
In order for the front-end to be able to have the JWT token (kept in LocalStorage), you must sign a transaction. Currently it can be done manually. Open REPL for UI:
lein repl :connect 54200
(shadow/repl :dev-ui)
(in-ns 'ethlance.ui.event.sign-in)
(re/dispatch [:user/sign-in])
- this will show a pop up and using MetaMask you can create a transaction
- after doing this successfully the UI graphql requests will have proper
Authorization: Bearer ...header
Then to generate some example data you can use server REPL:
lein repl :connect 54100
(shadow/repl :dev-server)
(in-ns 'tests.graphql.generator)
(generate-for-address "0xafcf1a2bc71acf041c93012a2e552e31026dfeab")
- for that the test namespace must be included in the server build (e.g. by adding
[tests.graphql.generator :as test-data-generator]toethlance.server.core) - alternatively you can submit the data manually through the forms
Start postgres console psql -d postgres
CREATE USER ethlanceuser WITH ENCRYPTED PASSWORD 'pass';
CREATE DATABASE ethlance WITH OWNER ethlanceuser;
-- alternatively if you created the database earlier, give access with:
GRANT ALL PRIVILEGES On ethlance TO ethlanceuser;Might require additional configuration for CORS if IPFS is running on a different host
ipfs config --json Gateway.HTTPHeaders.Access-Control-Allow-Methods '["PUT", "GET", "POST", "OPTIONS"]'
ipfs config --json Gateway.HTTPHeaders.Access-Control-Allow-Origin '["*"]'
ipfs config --json Gateway.HTTPHeaders.Access-Control-Allow-Headers '["X-Requested-With"]'
ipfs config --json Gateway.Writable trueThe ethlance smart contracts should (for now) be deployed manually. As a result of the compilation process, the environment specific clojure files with contract addresses get written (e.g. shared/src/ethlance/shared/smart_contracts_qa.cljs for QA) and must be committed to git to make them available for deployment of browser & server applications.
During clojure application deployment (browser, server), the contracts must only be compiled, which will generate JSON ABI files under <ethlance-root>/resources/public/contracts/build/
Compilation:
ETHLANCE_ENV=qa npx truffle compile(replacing the network with one suitable for the env)- This generates ABI JSON files under
<ethlance-root>/resources/public/contracts/build/ - Server app needs to access them during runtime:
- configured via
[:smart-contracts :contracts-build-path]
- UI (browser app) needs them available: should be served by Nginx (or your web server of choice)
- get loaded from urls like
http://d0x-vm:6500/contracts/build/TestToken.json
To build Server (consists mainly of graphql API):
- The following ENV variables need to be set:
export ETHLANCE_ENV=qa
- Compile with
clj -A:dev:shadow-clj release dev-server
- will result a single file in
out/ethlance_server.js(and accompanyingethlance_server.js.mapsource map)
- Before running it the smart contract ABI JSON files need to be in a location defined in the EDN file
ETHLNCE_CONFIG_PATHat EDN path[:smart-contracts :contracts-build-path]
- if it's a relative path, it gets resolved in relation to where the server process gets started
Running server:
- Earlier the server config was compiled into the generated JS file. Now it will be loaded during runtime (at application startup) from the variable specified under
:config :env-name. As for now it isETHLANCE_CONFIG_PATH. - Also earlier the UI (browser app) config was baked into the compiled JS file for the UI. Now it gets served via
/configendpoint from a location pointed to ENV variableUI_CONFIG_PATH(contents loaded at run time from the file system). Thus, starting the server:
export ETHLANCE_ENV=qaexport SERVER_CONFIG_PATH=/path/to/server-config-qa.ednexport UI_CONFIG_PATH=/path/to/ui-config-qa.ednnode out/ethlance_server.js
- The following ENV variables need to be set:
export ETHLANCE_ENV=qa
- Compile with
clj -A:dev:shadow-clj release dev-ui
- the generated JS file (single) will be under
<ethlance-root>/ui/resources/public/main.js
- To serve the web page, configure the web server to serve the files under
<ethlance-root>/ui/resources/public
- there are some other files, like CSS, JS and index.html that the web server needs to serve too
- The web server must also serve the ABI JSON files generated in 1. Smart contracts
- for that, they can be copied from the build step or re-compiled and moved to where the web server can serve them
- the expected HTTP path will be
/contracts/build/<ABI JSON FILE>.json(e.g./contracts/build/Ethlance.json)
Anyone is welcome to contribute to the ethlance project, here are some brief guidelines:
- Make sure to squash your commits
- Reference issue numbers in your pull request
- Rebase your changes on upstream (
git remote add upstream https://github.com/madvas/ethlance.git) master before pushing (git pull --rebase upstream master) - Make changes in a separate well-named branch in your forked repo
like
improve-readme
Here's a brief overview of the sequence of actions that different user types can take to create, find and arbiter jobs.
- User arrives to the home page
- http://d0x-vm:6500
- picks which profile to create (freelancer = candidate, employer, arbiter)
- This takes the user to the sign-up page
- http://d0x-vm:6500/me/sign-up?tab=candidate
- user fills in details for the roles they want to participate (candidate, employer, arbiter)
- Employer (having first filled in employer data)
- http://d0x-vm:6500/jobs/new
- user can create new job by filling in the form
- creating a new job requires sending a signed transaction together with the initial funds
- smart contract method
Ethlance#createJobis called and a new copy ofJobcontract gets deployed
- In case the employer invited arbiters during job creation
/jobs/new
- First: arbiter must send their quote (how much they want for their service for this job)
- ... where can they do it (one or more pages)?
- script helper:
tx-workflow-fns-server-repl/set-quote-for-arbitration
- Second: employer must accept the quote
- ... where can they do it (one or more pages)?
- script helper:
tx-workflow-fns-server-repl/accept-quote-for-arbitration
- Employer can now invite candidates to participate in the new job
- NB! implement & provide link
- results in
Job#addCandidatecontract send- script helper:
tx-workflow-fns-server-repl/add-candidate
- script helper:
- Candidate can search for available jobs
- Candidate chooses a job of interest from search results. To work on it, needs to send proposal
- http://d0x-vm:6500/jobs/detail/0x1A2f3f7739A52F5bDCc909A8d42e96Cd8f9f4D30
- as a result
JobStoryis created (DB model to track this user's interaction with this job)
- All users can view job contract page at
- http://d0x-vm:6500/jobs/contract/1
- send messages(all), raise disputes(candidate), resolve disputes(arbiter), leave feedback(all)
- Candidate can create invoices (for any of their jobs)
- Candidate can then raise dispute
- after raising dispute, arbiter can resolve it on the same page (http://d0x-vm:6500/invoices/new)
- resolving dispute results in tokens getting transferred according to the resolution amount
- Employer can pay invoices
- ... (add link, implement if needed)
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent