search

Developer-DUCS / BlockchainSim

Apache License 2.0
1 stars 1 forks source link

readme

BlockchainSim

The Beyond the Block blockchain simulator, BlockchainSim, is a Bit Coin Simulator developed at Drury University by Bryan Valencia, Laura Pareja, Seth Workman, Sean Lowry, Ean Vandergraaf, and Dawson Holderman under the direction of Dr. Scott Sigman and Dr. Chris Branton. The project is licensed under the Apache 2.0 license. Copyright 2021 by Drury University.

Current release code is found in the dev branch.

Quick Start

# Install dependencies for server
npm install

# Install dependencies for client (Re run this for new packages)
npm run client-install

# Start up the app for development
npm run dev

Errors

If you get React Hook error (mismatched React versions)

Extra Steps For Developers

  1. Use Visual Studio Code
  2. Install Prettier
  3. Make sure code auto formats to project standards.

Testing

# Run Tests (located in src/tests directory)
npm/yarn run test

Examples

  1. Api example: api/customers.js
  2. Basic React Example: components/Error.js

MySQL Database Setup

  1. Download MySQL Community Server Edition
  2. Install MySQL
  3. From the command line/terminal type: mysql -u root -p
  4. Enter the password you created during installation
  5. Once you are in the MySQL terminal type: source /path/to/scripts/databaseCreation.sql

Errors

If you run into the error when running MySQL: Client does not support authentication protocol requested by server; consider upgrading MySQL client

  1. Log into MySQL on the terminal mysql -u root -p
  2. Run following command where password is your password for MySQL ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY 'password';
  3. Run the following command flush privileges;

That should fix it :)

Deployment

  1. Clone repo and checkout the dev branch. Use the command sequence: git clone , git fetch --all , git branch -v -a , git checkout -b dev origin/dev
  2. Install dependencies: cd ./BlockchainSim , yarn install , cd client , yarn install
  3. Rename BlockchainSim to btb: mv ./BlockchainSim btb.
  4. Update database: If database has not been created follow steps on wiki to create database, else alter dbConn.js file to contain correct credentials
  5. Update client/package.json: insert “homepage” : “mcs.drury.edu/BtB”, below private and above dependencies, and insert “start”: “PORT=3220 react-scripts start” instead of "start": "react-scripts start".
  6. Update the .env file in the client subdirectory. REACT_APP_API_URL=mcs.drury.edu/BtB and add REACT_APP_URL_SCHEME=https as the last line.
  7. Update server.js to not include /BtB/ prefix in the routes. From: router.use("/BtB/api/users", require("./api/users")); to: router.use("/api/users", require("./api/users")); .
  8. Build project: cd client , npm run build.
  9. If there is a process node server.js running, stop it:
    • If ps aux | grep node server.js returns a process other than the grep process, note its pid.
    • Stop the process: kill -9 <pid from previous step>.
  10. Start/restart a process managed by pm2:
    • cd .., assuming you are in the client subdirectory.
    • If one exists, kill the old pm2 managed process: pm2 ls, pm2 delete <app>, where app is the number of the existing process.
    • Start the new server: pm2 start node server.js.
    • Ensure the server is started by pm2 at system restart/start: pm2 startup, follow the directions printed.
    • Save the pm2 information: pm2 save.
    • Note: If you are installing an instance for the first time, you will need to first install pm2: npm install -g pm2.