Getting Started

Cloning the Repository

Before cloning the repository, follow these steps to install Node and install MongoDB. 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
cd Core-v4
npm install

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

Running setup.py

Core-v4 makes use of the printingRPC repository to print paper and write to the LED sign. Running setup.py takes care of setting the repo up for you. Ensure you have python3 installed and run the script with:

# if macOS or linux:
python3 setup.py
# if Windows:
python setup.py

Running the Application

Frontend Only

To simply run the application's frontend, paste the below command into your terminal.

npm run frontend

Shortly after, a window in your browser will open with the website on localhost:3000.

Frontend and MongoDB

To get our database up and running, you can first run MongoDB with:

mongod

In a new terminal window or tab, run the application with the command below:

npm start

After some time, the application will load in the browser's terminal.

Having trouble?

Post any relevant screenshots in #development in the SCE Slack and we'll sort it out.