Sadkit

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Node.js is required to be installed on your system. In order to install Node.js, you can either download it directly or use nvm (Node Version Manager).

Sadkit has been developed using Node v9.2.0. Any higher version should be ok, I'd rather not go with a lower one.

As of January, 2019, npm is installed with Node.js. No further action should be required.

Check your environment by running the followin commands either in Terminal or Command Propmpt:

node -v 

npm -v 

Installing

Clone this repo. cd Sadkit and run npm install.

Run node server in order to start Sadkit. By default, Sadkit requires ports 80, 443, 8080, 8443. Ensure these ports are not in use by another program or change them in the configuration files.

Configuring

Sadkit can be configured by modifying and extending the JSON configuration files under the system/ directory, within the project. Further explanation about available properties will be available in the Documentation (work in progress).

Deployment

It is highly recommended to generate proper SSL certificates. Take a look at Let's Encrypt for a free secure web.

Built With

• Node.js - Runtime Environment
• npm - Dependency Management
• Koa - Web Framework

Contributing

Feel free to open an Issue or send me a direct message.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Daniele Molinari - Sadkit

License

This project is licensed under the Apache License 2.0 - see the LICENSE.md file for details.

Acknowledgments

• Major thanks to Ryan Dahl, creator of Node.js and to all of the npm contributors. Follow their repos in package.json in order to find them all.