steedos-platform/CONTRIBUTING.md

CONTRIBUTING GUIDE

Development Environment

We recommend using Gitpod for online development, which eliminates the tedious process of setting up a development environment.

If you need to deploy the development environment locally, you can refer to the following Gitpod configuration files, which describe the specific process:

• .gitpod.Dockerfile
• .gitpod.yml

gitpod-workspace-base:2.1 is the docker of steedos template project, see it's .gitpod.Dockerfile for more.

Requirements

• MongoDB version = 4.2.17. MongoDB is a general purpose, document-based, distributed database built for modern application developers.
• Redis version = 6.2.6.
• Node.js version = 12.22.7 (which can be checked by running node -v). You can use nvm for managing multiple Node versions on a single machine installed.
• Yarn version = 1.22.17 (which can be checked by running yarn version). Yarn is a performant package manager for JavaScript and replaces the npm client. It is not strictly necessary but highly encouraged.
• Meteor version = 1.9.3. Meteor is an open source platform for web, mobile, and desktop used by over half a million developers around the globe to make shipping javascript applications simple, efficient, and scalable.

Only when you run the source code in '/creator' folder of our platform, you need to install Meteor. If you use Steedos as a development tool, you do not need to install Meteor.

Prepare For Development

• Clone this repository to your local.
• Enter to the local folder of this repository by command line.
• Run yarn on command line to install the dependent NPM packages.
• Then run yarn bootstrap to auto link the npm packages that mentioned in the file lerna.json by lerna.
• Then run yarn build to auto build all NPM packages in the folder "packages" and "services" of the source code.
• Start the MongoDB service.

Run Project

• Run yarn start on the command line to start the template project in the folder /steedos-projects/project-community

• Use your browser to access http://localhost:5000.

You will see the initialization page for activating the steedos project after starting the project for the first time.

You do not need to run yarn on command line in the folder /steedos-projects/project-community to install the dependent NPM packages, because all of the dependence are linked to the souce code or the node_modules of the parent folder.

Here you are using our source code as the development tool, you do not need to install Meteor.

Activate Steedos

Sign up for an account at Steedos Customer Portal and then refer to this document to activate Steedos.

Run The Source Code Of Meteor Bundle

The code in the folder '/creator' of this repository is the souce code of a Meteor application. And all of it's code will build to the '/server' folder as a NPM package named 'steedos-server'.

The code in '/packages' is our souce code of some core NPM packages on which the Meteor application above based on.

If you only need to debug the source code in the '/packages', you shoud just Run Project.

You will need to read the tutorial bellow only when you need to debug the source code of Meteor application in the '/creator' folder.

Environment variable

You should add a .env.local file to the '/creator' folder, and add some content as as the web service url and mongo server url like this:

ROOT_URL=http://127.0.0.1:3100
MONGO_URL=mongodb://127.0.0.1/steedos

settings.json

As a Meteor application in the '/creator' folder, You cannot use steedos-config.yml as the configuration file, but you can add a file named settings.json to do the same.

The content of the setting.json may like this:

{
    "email": {
        "from": "Steedos <noreply@message.steedos.com>"
    }
}

Run Creator

• Enter to the '/creator' folder of this repository by command line.
• Run yarn on command line to install the dependent NPM packages.
• Then you can start the service just by run yarn start.
• Use your browser to access http://127.0.0.1:3100.

Build Creator

You can run the shell bellow on command line to build all of the source code of '/creator' to the '/server' folder as a NPM package named 'steedos-server'.

cd creator/
export TOOL_NODE_FLAGS="--max-old-space-size=3800"
yarn run build

Test Creator Code After Build

After the command line shell execution of Build Creator above, the built code will be copied automatically to the /server folder.

You can simply Run Project to test the code that has just been built from the source code in the '/creator' folder.

Publish

After passing the test of Creator Code, you should release a new version for both the packages in the '/packages' folder and the package named 'steedos-server' in the '/server' folder, so that to unify all of the packages version numbers.

See Publish Guide for more.