Skip to content
Steem Engine Tokem Customized UI, based on Steemit condenser
JavaScript CSS Other
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Merging master Mar 17, 2019
.storybook add webpack alias for decorators dir Mar 9, 2018
api_mockdata add benchmark component and route, refs #2269 Jan 30, 2018
blackboxtest Bump sshpk from 1.13.1 to 1.16.1 in /blackboxtest Jun 5, 2019
config revive enabled flag Sep 4, 2019
doc Update contribution guidelines (#3391) Jun 6, 2019
scripts signup removal progress Feb 6, 2019
src Merge remote-tracking branch 'nitrous/master' into scotty Oct 15, 2019
webpack GPT Bidding 2 Apr 26, 2019
.babelrc updated files in condenser to help dev initial setup run immediately … Jun 19, 2017
.dockerignore prepare for PaaS deployment: docker and config env vars Feb 9, 2017
.editorconfig run eslint via pre-commit and report linting issues for changed files… Oct 3, 2017
.eslintrc Fix all i18n and linting warnings (#1779) Oct 5, 2017
.gitignore merge server-compile-src Jul 21, 2017
.nsprc ignore hoek vulnerability Feb 16, 2018
.prettierignore Create .prettierignore May 20, 2019
.prettierrc json-ify config Dec 4, 2017
.travis.yml add test in master Jun 17, 2019
CONTRIBUTING.md Update contribution guidelines (#3391) Jun 6, 2019
Dockerfile add source_commit and docker_tag build args Jun 14, 2018
Makefile latest Feb 14, 2017
Procfile Procfile and versions listed on readme May 3, 2019
README.md remove outdated line Jun 3, 2019
Vagrantfile vagrant support Feb 13, 2017
component_counter.sh working storybook (#2146) Dec 20, 2017
mocha.setup.js merge server-compile-src Jul 21, 2017
package.json lodash packages security vuln. Aug 27, 2019
yarn.lock lodash packages security vuln. Aug 27, 2019

README.md

Nitrous

Nitrous is the customized condenser (see below) that integrates with the Steem Engine Token Scotbot.

The instructions below are still accurate, but you need a few things to configure.

src/app/client_config.js collects most of the settings that are necessary to configure.

When running, SDC_IMAGE_PROXY_PREFIX and SDC_UPLOAD_IMAGE_URL can be set to https://steemitimages.com (eventually this dependency should be changed). SDC_IMAGE_PROXY-PREFIX may also need a trailing /.

Change src/app/assets/images/favicons with your own, and also change src/app/assets/static/manifest.json and src/server/server-html.jsx accordingly.

Condenser

Condenser is the react.js web interface to the world's first and best blockchain-based social media platform, steemit.com. It uses STEEM, a blockchain powered by DPoS Governance and ChainBase DB to store JSON-based content for a plethora of web applications.

Installation

Docker

We highly recommend using docker to run condenser in production. This is how we run the live com site and it is the most supported (and fastest) method of both building and running condenser. Configuration settings can be set using environment variables (see configuration section below for more information). If you need to install docker, you can get it at https://get.docker.com

To modify, build, and run condenser using docker, it's as simple as pulling in the github repo and issuing one command to build it, like this:

git clone https://github.com/eonwarped/nitrous
cd nitrous
docker build -t="myname/condenser:mybranch" .
docker run -it -p 8080:8080 myname/condenser:mybranch

Building from source without docker (the 'traditional' way):

(better if you're planning to do condenser development)

Clone the repository and make a tmp folder

git clone https://github.com/eonwarped/nitrous
cd nitrous
mkdir tmp

Install dependencies

Install at least Node v8.7 if you don't already have it. We recommend using nvm to do this as it's both the simplest way to install and manage installed version(s) of node. If you need nvm, you can get it at https://github.com/creationix/nvm.

Condenser is known to successfully build using node 8.7, npm 5.4.2, and yarn 1.3.2.

Using nvm, you would install like this:

nvm install v8.7

We use the yarn package manager instead of the default npm. There are multiple reasons for this, one being that we have steem-js built from source pulling the github repo as part of the build process and yarn supports this. This way the library that handles keys can be loaded by commit hash instead of a version name and cryptographically verified to be exactly what we expect it to be. Yarn can be installed with npm, but afterwards you will not need to use npm further.

npm install -g yarn
yarn global add babel-cli
yarn install --frozen-lockfile
yarn run build

To run condenser in production mode, run:

yarn run production

When launching condenser in production mode it will automatically use 1 process per available core. You will be able to access the front-end at http://localhost:8080 by default.

To run condenser in development mode, run:

yarn run start

It will take quite a bit longer to start in this mode (~60s) as it needs to build and start the webpack-dev-server.

By default you will be connected to steemit.com's public steem node at https://api.steeemit.com. This is actually on the real blockchain and you would use your regular account name and credentials to login - there is not an official separate testnet at this time. If you intend to run a full-fledged site relying on your own, we recommend looking into running a copy of steemd locally instead https://github.com/steemit/steem.

Debugging SSR code

yarn debug will build a development version of the codebase and then start the local server with --inspect-brk so that you can connect a debugging client. You can use Chromium to connect by finding the remote client at chrome://inspect/#devices.

Configuration

The intention is to configure condenser using environment variables. You can see the names of all of the available configuration environment variables in config/custom-environment-variables.json. Default values are stored in config/defaults.json.

Environment variables using an example like this:

export SDC_CLIENT_STEEMD_URL="https://api.steemit.com"
export SDC_SERVER_STEEMD_URL="https://api.steemit.com"

Keep in mind environment variables only exist in your active session, so if you wish to save them for later use you can put them all in a file and source them in.

If you'd like to statically configure condenser without variables you can edit the settings directly in config/production.json. If you're running in development mode, copy config/production.json to config/dev.json with cp config/production.json config/dev.json and adjust settings in dev.json.

If you're intending to run condenser in a production environment one configuration option that you will definitely want to edit is server_session_secret which can be set by the environment variable SDC_SESSION_SECRETKEY. To generate a new value for this setting, you can do this:

node
> crypto.randomBytes(32).toString('base64')
> .exit

Style Guides For Submitting Pull Requests

File naming and location

  • Prefer CamelCase js and jsx file names
  • Prefer lower case one word directory names
  • Keep stylesheet files close to components
  • Component's stylesheet file name should match component name

Js & Jsx

We use prettier to autofromat the code, with this configuration. Run yarn run fmt to format everything in src/, or yarn exec -- prettier --config .prettierrc --write src/whatever/file.js for a specific file.

CSS & SCSS

If a component requires a css rule, please use its uppercase name for the class, e.g. "Header" class for the header's root div. We adhere to BEM methodology with exception for Foundation classes, here is an example for the Header component:

<!-- Block -->
<ul class="Header">
  ...
  <!-- Element -->
  <li class="Header__menu-item">Menu Item 1</li>
  <!-- Element with modifier -->
  <li class="Header__menu-item--selected">Element with modifier</li>
</ul>

Storybook

yarn run storybook

Testing

Run test suite

yarn test

will run jest

Test endpoints offline

If you want to test a server-side rendered page without using the network, do this:

yarn build
OFFLINE_SSR_TEST=true NODE_ENV=production node --prof lib/server/index.js

This will read data from the blobs in api_mockdata directory. If you want to use another set of mock data, create a similar directory to that one and add an argument OFFLINE_SSR_TEST_DATA_DIR pointing to your new directory.

You can’t perform that action at this time.