Getting Started

Cloning the Repository

Before cloning the repository, follow these steps to install Node and install Python. Once you have installed both, we can move onto the next steps.

To download and set up the repo, simply copy and paste this into your terminal.

git clone https://github.com/SCE-Development/Core-v4.git

If you find that git is not installed, you can install it here.

Installing Dependencies

We have scripts to take care of this for you. Within the SCE-RPC folder: If Linux/MacOS

./setup.sh

if Windows:

.\setup.bat

All python and node dependencies should be installed and the project should be ready to run.

Running the project

From the top of the SCE-RPC folder:

Activate virtual environment

For MacOS and Linux: source modules/bin/activate

If Windows:

1. Open Command Prompt and go to SCE-RPC folder: cd SCE-RPC
2. Activate virtual environment: modules\Scripts\activate.bat

Run the RPC Servers and Client API

# To run the SCE-RPC API for other projects to interact with it:
npm run start

# To run the printing server:
python server/printing/printing_server.py

# To run the led sign server:
python server/led_sign/led_sign_server.py

# To run the 3d printing server:
python server/printing_3d/print_3d_server.py

Note: If you get some unexpected errors from the python commands, replace python with python3