Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(env): added setup.sh and readme updates for working build and run #79

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

chore(env): added setup.sh and readme updates for working build and run #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d28561d
added setup.sh and readme updates for working build and run
mike-cleaver Apr 27, 2023
f5d2ba5
Merge branch 'main' into main
mickster04 Sep 5, 2023
cc7c7d3
moved scripts folder
mike-cleaver Sep 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,25 @@ This repo contains the source code to SimBridge
Please make sure you have:

NodeJS 16 - [Homepage](https://nodejs.org/en/)
- Install the latest node/npm,
- Install [NVM for windows](https://github.com/coreybutler/nvm-windows) or [nvm for *nix](https://github.com/nvm-sh/nvm)
- $ nvm install v16.20.0
- $ nvm use 16.20.0


First time
```bash
# Install all dependencies
$ npm install
$ ./scripts/setup.sh
```

# Build all packages
$ npm run build
then every time to want to run it
```bash

# Start server, to use interfaces you need to build them beforehand
$ npm run start

#or if you want to use magic hot reloading upon save
$ npm run start:dev

# Wipe build/ and dist/ folders, build all packages, package to exe and copy dependencies/resources to build folder
$ npm run build:exec

Expand Down
13 changes: 13 additions & 0 deletions scripts/setup.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@

# Install all dependencies
npm install
#copy dependancies to places
npm run copy:deps

# move the `build/resources` folder to the project root folder (overwrite everything)
cp -rf ./build/resources ./
# move the `build/terrain` folder to the project root folder
cp -rf ./build/terrain ./

#copy up simconnect dll
cp build/Simconnect.dll ./
Loading