emmoistner/sbox

Mock file transfer application dedicated to simulating a real world codebase

Sbox Monorepo

---

• Structure
• Getting Started
  • Dev Environment Setup
• Commands
• Advanced Setup

Project

• frontend - React App
• backend - Express REST APIs

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Dev Environment Setup

Clone project

git clone https://github.com/emmoistner/sbox.git
cd sbox

Node install

Must at least have node version 10.15 or above! Ignore this step if you already have node installed at the correct version

# This should install the version designated in .nvmrc
nvm install

Install dependencies

npm run setup

Running code

# This will start both the backend apis as well as the frontend react application
npm start

Commands

• setup
• start
• test

Setup

runs npm install for every package (frontend, backend)

npm run setup

Start

runs npm start for every package (frontend, backend)

npm run start

Advanced Setup

Setting up aws credentials (DEVOPS only)

Create the directory ~/.aws and file credentials

mkdir ~/.aws
cd ~/.aws
nano credentials

Add your ID and Secret to ~/.aws/credentials

[default]
aws_access_key_id=<ID>
aws_secret_access_key=<SECRET>

[dev]
aws_access_key_id=<ID>
aws_secret_access_key=<SECRET>