Skip to content

Commit ccf5752

Browse files
committed
Update README.md
1 parent f01428c commit ccf5752

1 file changed

Lines changed: 8 additions & 26 deletions

File tree

README.md

Lines changed: 8 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,17 @@
1-
# Engine Web Server
1+
# EngineWebServer - Web API for Rocket Engine Control
22

3-
The purpose of the Liquid Propulsion Group web server is to provide a REST api to control circuits through I2C or SPI communication bus. We hope to build it with web technologies to make this more accessiable to the modern programer. **The intention of this webserver is only ment to be used on a rocket test stand using a raspberry pi or similar SBC.** The reason to use a webserver on a rocket engine is so we have a more open source communication system for tests using everyday off the shelf networking tools like routers and patch antenas.
3+
EngineWebServer is Liquid Propulsion Groups edge software that is used on a static rocket for engine testing. This Web API is used to control a rocket engine from a safe distance.
44

5-
## Why TypeScript?
5+
Express is used to serve routes and the SerialPort is used to control hardware. The project is written in TypeScript for its strong static typing and less error-prone nature.
66

7-
Most modern REST api's are made with javascript but, not every engineer knows javascript. TypeScript on the other hand makes transitioning from languages like C, Java, RUST, and even Arduino easy because its a typed languaged. In addition, TypeScript was developed and designed for large applications in mind; Liquid Propulsion Group plans to levrage this heavly in the future.
7+
To use our code please follow the [wiki](https://github.com/LiquidPropulsionGroup/EngineWebServer/wiki).
88

9-
## Requirements
9+
## Versions
1010

11-
To start development you must have:
11+
1. > [v1.0 ~ Valve Control Update](https://github.com/LiquidPropulsionGroup/EngineWebServer/releases/tag/v1.0)
1212
13-
- Node.js
14-
- TypeScript
13+
### Authors
1514

16-
## Install
17-
18-
1. Fork or clone the main repository found [here](https://github.com/LiquidPropulsionGroup/EngineWebServer)
19-
2. In the EngineWebServer folder run `npm install`
20-
3. Run the project using the following command `npm run start`
21-
22-
## Projects Baisc Structure
23-
24-
**src Folder:**
25-
In the scr folder all of our TypeScript code will live in. This is also the folder that we will compile down to javascript.
26-
27-
**src/app.ts File:**
28-
app.ts is a file in our src folder where our express routing functionality is initialized.
29-
30-
**src/index.ts File:**
31-
index.ts is a file in our src folder where we will expose the express process on our local machine.
32-
33-
## Authors
15+
---
3416

3517
- Brian Almaguer/Haro ([BalmaBrian](https://github.com/BalmaBrian))

0 commit comments

Comments
 (0)