An open platform to save anonymous data coming from any application using this API
If you want to use the connect api service see the full usage guide to learn more about it.
Refer to the following example projects that use connect API
- Using WebApp and Arduino Uno: Sending AirQuality data to connect using a web application connected to Arduino Uno and MQ135 gas sensor.
- Using ESP32 Node MCU: Sending Air Quality data is updated every 10 minutes with help ESP32 Node MCU amd MQ135 gas sensor.
- getObj: Example to get selected classes from connect using python
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
What things you need to install the software
node v14+
yarn v1.16+
docker-compose v1.23+ (or a Mongo database)
Clone the repo
git clone https://github.com/ConnectProject/connect
Init and update the submodules
cd connect
git submodule init
git submodule update
Setup env variables.
cp .env.dist .env
Edit the .env file to set your custom values.
The parse dashboard password have to be bcrypt hash (see https://bcrypt-generator.com/)
Create a new OAuth application and set the callback URL to PUBLIC_URL/login/github
Start the docker compose to get a mongo db ready to use
docker-compose up -d
Alternatively, you can use a Mongo DB without Docker, but you will need to create the three databases MONGO_DB_NAME, MONGO_DB_NAME-apiand MONGO_DB_NAME-sandbox and give readWrite access to the user MONGO_USERNAME ad defined in the environment variables. If the Mongo DB is in your local computer and you want to avoid this step, you can leave blank the variables MONGO_USERNAME and MONGO_PASSWORD so Mongo DB will be accessed without access control and connect will automatically create the tables when needed.
Install the node modules
yarn install
Build the react application
yarn build.dev
The project is ready to run
yarn start
To run jest tests :
yarn test