======== Steemit.com is the react.js web interface to the world's first and best blockchain-based social media platform. It uses STEEM, a blockchain powered by Graphene 2.0 technology to store JSON-based content for a plethora of web applications.
Why would I want to use Steemit.com?
- Learning how to build blockchain-based web applications using STEEM as a content storage mechanism in react.js
- Reviewing the inner workings of the steemit.com social media platform
- Assisting with software development for steemit.com
Clone the repository and make a tmp folder
git clone https://github.com/steemit/steemit.com cd steemit.com mkdir tmp
# Install at least Node v6.3 if you don't already have it ([NVM](https://github.com/creationix/nvm) recommended) nvm install v6 npm install npm install -g babel-cli
Create config file
cd config cp steem-example.json steem-dev.json
Generate a new crypto_key and save under server_session_secret in ./steem-dev.json.
node > crypto.randomBytes(32).toString('base64')
(note: it's steem.json in production)
Install mysql server
OS X :
brew update brew doctor brew upgrade brew install mysql mysql.server restart
Debian based Linux:
sudo apt-get update sudo apt-get install mysql-server
On Ubuntu 16.04+ you may be unable to connect to mysql without root access, if so update the mysql root user as follows::
sudo mysql -u root DROP USER 'root'@'localhost'; CREATE USER 'root'@'%' IDENTIFIED BY ''; GRANT ALL PRIVILEGES ON *.* TO 'root'@'%'; FLUSH PRIVILEGES;
Now launch mysql client and create steemit_dev database:
mysql -u root > create database steemit_dev;
npm install -g sequelize sequelize-cli pm2 mysql
sequelize db:migrate in
You now have your development front end running at localhost:3002, connected to the main public steem blockchain. You don't need to run
steemd locally, by default you will connect to
ws://node.steem.ws. Use your regular account name and credentials to login -- there is no separate dev login.
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
CSS & SCSS
If 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>
If you want to test it locally in production mode, just run the following commands:
npm run build npm run prod
or via pm2:
npm run build npm -i -g pm2 # one time pm2 start config/process.json
To report a non-critical issue, please file an issue on this GitHub project.
If you find a security issue please report details to: firstname.lastname@example.org
We will evaluate the risk and make a patch available before filing the issue.