mirror of
https://github.com/eliasrenman/gardentron.git
synced 2026-03-17 04:56:06 +01:00
43 lines
1.0 KiB
Markdown
43 lines
1.0 KiB
Markdown
# server
|
|
|
|
> The server for handling two way communication with a iot Device
|
|
|
|
## About
|
|
|
|
This project uses [Feathers](http://feathersjs.com). An open source framework for building APIs and real-time applications.
|
|
|
|
## Getting Started
|
|
|
|
1. Make sure you have [NodeJS](https://nodejs.org/) and [npm](https://www.npmjs.com/) installed.
|
|
2. Install your dependencies
|
|
|
|
```
|
|
cd path/to/server
|
|
npm install
|
|
```
|
|
|
|
3. Start your app
|
|
|
|
```
|
|
npm run compile # Compile TypeScript source
|
|
npm run migrate # Run migrations to set up the database
|
|
npm start
|
|
```
|
|
|
|
## Testing
|
|
|
|
Run `npm test` and all your tests in the `test/` directory will be run.
|
|
|
|
## Scaffolding
|
|
|
|
This app comes with a powerful command line interface for Feathers. Here are a few things it can do:
|
|
|
|
```
|
|
$ npx feathers help # Show all commands
|
|
$ npx feathers generate service # Generate a new Service
|
|
```
|
|
|
|
## Help
|
|
|
|
For more information on all the things you can do with Feathers visit [docs.feathersjs.com](http://docs.feathersjs.com).
|