Skip to content

ProjektDevLights/Server

Repository files navigation

Logo

Description

DevLights are the smart home LED Stripes for Developers. This is the DevLights server based on the NestJS JavaScript framework, which provides the API and thus the communication between clients and the Hardware Works on Linux, Windows and macOS. Intended to use on a Raspberry Pi.

Prerequisites

Make sure that you have either npm or yarn installed. If you haven't than you can look here for npm, or here for yarn. Next set up a mongoDB database either on your machine or on mongoDB Atlas. A redis server for caching is also required.

Getting started

git clone https://github.com/ProjektDevLights/Server.git
cd Server 
yarn install
yarn start:dev

After running these few commands, your development server is running, and you can start changing or adding things you want, so they will be applied immediately.

If you want go to production mode just run npm run build or yarn run build and start the server via the start script.

Contributing

Feel free to open an issue on GitHub or send pull requests, when encountering issues or wanting to add some features. If you have any questions email [email protected] or [email protected].