6.0 KiB
Commons
🏄♀️ Marketplace front-end and backend server to explore, download, and publish open data sets. https://commons.oceanprotocol.com
🦑🦑🦑
This marketplace is deployed under commons.oceanprotocol.com and can be used there. Feel free to report any issues you encounter.
🦑🦑🦑
If you're a developer and want to contribute to, or want to utilize this marketplace's code in your projects, then keep on reading.
🏄 Get Started
This repo contains a client and a server, both written in TypeScript:
- client: React app setup with squid-js, bootstrapped with Create React App
- server: Node.js app, utilizing Express. The server provides various microservices, like remote file checking.
To spin up both, the client and the server in a watch mode for local development, execute:
npm install
npm start
Open http://localhost:3000 to view the client in the browser. The page will reload if you make edits to files in either ./client or ./server.
🏖 Remote Ocean: Nile
To make use of all the functionality, you need to connect to the Ocean network. By default, the client will connect to Ocean components running within Ocean's Nile test network remotely.
This means you need to connect with your MetaMask to the Nile network too. To do this:
- select Custom RPC in the network dropdown in MetaMask
- under New Network, enter
https://nile.dev-ocean.comas the custom RPC URL - Hit Save, and you’re now connected to Nile
🐳 Use with Barge
If you prefer to connect to locally running components instead of remote connections to Ocean's Nile network, you can spin up barge and use a local network:
git clone git@github.com:oceanprotocol/barge.git
cd barge
./start_ocean.sh --latest --no-pleuston --local-spree-node
Modify ./client/src/config.ts to use those local connections.
👩🔬 Testing
Test suite is setup with Jest and react-testing-library.
To run all tests, including all linting tests:
npm test
For local development, you can start the test runners for client & server in a watch mode.
npm run test:watch
This will work for daily development but it misses the full interactivity of the test runner. If you need that, you will need to run them in individual terminal sessions:
cd client/
npm run test:watch
cd server/
npm run test:watch
✨ Code Style
For linting and auto-formatting you can use from the root of the project:
# auto format all ts & css with eslint & stylelint
npm run lint
# auto format all ts & css with prettier, taking all configs into account
npm run format
🛳 Production
To create a production build of both, the client and the server, run from the root of the project:
npm run build
Builds the client for production to the ./client/build folder, and the server into the ./server/dist folder.
⬆️ Releases
Running any release task does the following:
- bumps the project version
- creates a Git tag
- updates CHANGELOG.md file with commit messages
- commits and pushes everything
- creates a GitHub release with commit messages as description
You can execute the script using {major|minor|patch} as first argument to bump the version accordingly:
- To bump a patch version:
npm run release - To bump a minor version:
npm run release-minor - To bump a major version:
npm run release-major
By creating the Git tag with these tasks, Travis will trigger a new Kubernetes deployment automatically aftr a successful tag build.
For the GitHub releases steps a GitHub personal access token, exported as GITHUB_TOKEN is required. Setup
🎁 Contributing
See the page titled "Ways to Contribute" in the Ocean Protocol documentation.
🏛 License
Copyright 2018 Ocean Protocol Foundation Ltd.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.