|
|
## Table of Contents
|
|
|
|
|
|
| |
|
|
|
|:------------------------------------------------------------------------------|
|
|
|
|[Introduction](Getting-Started-with-@kwaeri/Node-kit/)|
|
|
|
|[The History of NK](Getting-Started-with-@kwaeri/The-History-of-NK)|
|
|
|
|[How to Build a Kwaeri Application](Getting-Started-with-@kwaeri/How-to-Build-a-node-kit-Application)
|
|
|
|
|
|
## In this Article
|
|
|
|
|
|
| |
|
|
|
|:------------------------------------------------------------------------------|
|
|
|
|[Prerequisites](#prerequisites)|
|
|
|
|[Prepare the Environment](#prepare-the-environment)|
|
|
|
|[Start a Project](#start-a-project)|
|
|
|
|[Kwaeri API Projects](#kwaeri-api-projects)|
|
|
|
|[Kwaeri React Projects](#kwaeri-react-projects)|
|
|
|
|[The Future](#the-future)|
|
|
|
|
|
|
## Prerequisites
|
|
|
|
|
|
Before we can begin building a node-kit application, it's required that some prerequisite - or required - software is installed within your development environment:
|
|
|
|
|
|
* Node.js (https://nodejs.org
|
|
|
* NPM (though it now comes with node.js)
|
|
|
* MySQL or PostgreSQL Server
|
|
|
* In a future release a NoSQL alternative will be supported
|
|
|
|
|
|
Once you have these prerequisites installed, it's time to move forward!
|
|
|
|
|
|
## Prepare the Environment
|
|
|
|
|
|
There are two options for using node-kit for building an application.
|
|
|
|
|
|
1. Download a project template, install dependencies, and move forward using the nk tooling.
|
|
|
2. Install node-kit globally, move forward using the nk tooling.
|
|
|
|
|
|
While option 1 is entirely valid, it's more specific to using node-kit in 1-off situations. If you intend to use node-kit regularly, you'll be able to generate projects on-the-fly, as well as leverage all of nk in your development process in order to enable rapid development.
|
|
|
|
|
|
### Project Templates
|
|
|
|
|
|
If you decide to go with option 1, then all you need to do is install 1 of the 2 project templates which are offered at this time:
|
|
|
|
|
|
* [Kwaeri API Project](https://gitlab.com/mmod/kwaeri-api-app) for a back-end API project.
|
|
|
* [Kwaeri React Project](https://gitlab.com/mmod/kwaeri-react-app) for a front-end React project.
|
|
|
|
|
|
Once you have decided on a project type (and we understand you may require both, ultimately) it's as easy as cloning the project:
|
|
|
|
|
|
```bash
|
|
|
git clone https://gitlab.com/mmod/kwaeri-api-app
|
|
|
```
|
|
|
|
|
|
And then installing dependencies:
|
|
|
|
|
|
```bash
|
|
|
npm install .
|
|
|
```
|
|
|
|
|
|
From here, you can follow the same documentation as option 2 from after generating a project - HERE.
|
|
|
|
|
|
### node-kit Tooling
|
|
|
|
|
|
node-kit is a platform for development which makes it easy to develop applications for Node.js. In order to make full use of node-kit tooling, simply install the platform globally within your development environment:
|
|
|
|
|
|
```bash
|
|
|
npm install -g @kwaeri/node-kit
|
|
|
```
|
|
|
|
|
|
Now you're set to make full use of node-kit tooling. You can generate project structures easily. Start by changing your working directory within your command-prompt/terminal to a workspace directory for @kwaeri projects:
|
|
|
|
|
|
```bash
|
|
|
mkdir -p ~/workspaces/@kwaeri
|
|
|
cd ~/workspaces/@kwaeri
|
|
|
```
|
|
|
|
|
|
Then generate the project type you desire. For an API project run the following command:
|
|
|
|
|
|
```bash
|
|
|
nkm generate --project --type api MyAPIProject
|
|
|
```
|
|
|
|
|
|
Or, for a React project, run the following command:
|
|
|
|
|
|
```bash
|
|
|
nkm generate --project --type react MyReactProject
|
|
|
```
|
|
|
|
|
|
node-kit makes full use of asynchronous methods, and contains the file contents within generators - so there is no waiting for any downloads, and file-contents are customized according to several bits of information which you will provide during the wizard.
|
|
|
|
|
|
## Start a Project
|
|
|
|
|
|
Documentation coming soon!
|
|
|
|
|
|
## Kwaeri API Project
|
|
|
|
|
|
Documentation coming soon!
|
|
|
|
|
|
## Kwaeri React Project
|
|
|
|
|
|
Documentation coming soon!
|
|
|
|
|
|
## The Future
|
|
|
|
|
|
Documentation coming soon! |
|
|
\ No newline at end of file |