Skip to content

installation.md

Latest commit

 

History

History
219 lines (131 loc) · 5.7 KB

installation.md

File metadata and controls

219 lines (131 loc) · 5.7 KB

Installation Guide

This section goes over instruction for the developer and non-software engineer installation process

Developer installation

This section will go over environment dependencies and setup.

Requirements

NodeJS

If you do not have Node please go to https://nodejs.org/en/download/ and install the latest stable version.

you can test if the installation worked by typing the commands

npm -v
node --version

If they don't give you errors then installation of node was successful.

TypeScript

npm i -g typescript

verify installation

tsc --version

Rust

Go to rust and follow the instructions to install rust.

Docker

Go to the Docker Desktop documentation and follow the installation instructions for your OS. Docker desktop contains the Docker Engine and other Docker software required for running Ground Support in a container.

MongoDB Atlas

One option for database hosting is using cloud resources, if you prefer not to use cloud tool or need offline capabilities skip this and use the local database hoster mongodb compass. Our database will be hosted by MongoDB itself on MongoDB Atlas.

First go to Atlas sign in and sign up for an account.

Dev Environment Setup

Now if you haven't already you can clone the repository

git clone https://github.com/UVicRocketry/Ground-Support.git

Then clone project submodules

cd Ground-Support
git submodule update --init --recursive

Server Environment File

In the /services/server directory create a .env file. If not called exactly .env, create one and copy and paste

MONGO_USERNAME = ''
MONGO_PASSWORD = ''
MONGO_DB_STRING = ''
SERVER_PORT = ''

Create Remote Database

To use the app you must first create a remote database for your environment to do this go to mongoBD Atlas and create a new database.

Select the free option

Select the AWS hosting service with a North american Server. And Name your cluster GroundSupport

Create an Admin User with the credentials

Username: SupportAdmin

Password: UVR2015

In the .env file fill in the password and username with the credentials above

Network Access

In Here you can setup which IP addresses can access your database. For now click add new IP address and select add current ip address button.

⚠️ Do not click allow access anywhere. That is reserved for the production version.

Next click on the database tab on the left and click the Connect button for the GroundSupport database.

A popup will appear, click connect your application. This will give you a Connection String. All connection strings are different.

The connection string will look something like this

mongodb+srv://${MONGO_USERNAME}:${MONGO_PASSWORD}@groundsupport.${MONGO_DB_STRING}.mongodb.net/;

Copy the part in the place of ${MONGO_DB_STRING} and paste it into the .env file in the MONGO_DB_STRING variable.

Create Local Database

If you are JJ and scared of Hosting your data you can install a local database for development

To do that you will need mongo DBs data management application Compass to get it go to: Download and install the newest community addition.

Go through the installer. Choose the Complete option

Copy this Path

alter the path to MongoDB/Server/6.0/bin

Navigate to that path in your favorite terminal

copy connection string into .env file

Docker Dev Setup

From the project root, run the following in a terminal

$ docker compose up --build

This command will build and run the Ground Support container. Unless removed, the Ground Support container will persist and can be started and stopped as needed. After the initial build, the --build flag can be omitted when starting the container.

Once running, the Ground Support client will be available at localhost:3000, and the container will update when changes are made to the local source.

If developing through Docker, a local dev setup is not required.

Local Dev Setup

Dependencies

Next to get everything set up all node module dependencies must be installed.

To do this run

npm install && cd client && npm --force install && cd ../services/server && npm i

There is currently a bug when installing the dependencies for the client, the library react-material-file-upload was installed using --force. Therefore --force flag is necessary to install.

This will install and update all dependencies and setup the environment variables

Now for telemetry

First navigate to /services/telemetry/ and install all rust dependencies with

cargo build

Backend

Navigate to ./services/server

npm run server

Frontend

Navigate to ./client/src

npm start

Telemetry Backend

TBD (@JackCotter) once rust backend is more functional

Non-technical installation

download the newest release ... (update when there is a release)