https://github.com/bubao/keyboard-builder-server

keyboard builder server
https://github.com/bubao/keyboard-builder-server

Last synced: 7 days ago
JSON representation

keyboard builder server

• Host: GitHub
• URL: https://github.com/bubao/keyboard-builder-server
• Owner: bubao
• License: mit
• Created: 2019-09-09T15:40:07.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-08T00:16:09.000Z (almost 2 years ago)
• Last Synced: 2023-11-13T19:26:24.713Z (about 1 year ago)
• Language: JavaScript
• Size: 331 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        



  

 



keyboard-builder-server




[![Status](https://img.shields.io/badge/status-active-success.svg)]()

[![GitHub Issues](https://img.shields.io/github/issues/bubao/keyboard-builder-server.svg)](https://github.com/bubao/keyboard-builder-server/issues)

[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/bubao/keyboard-builder-server.svg)](https://github.com/bubao/keyboard-builder-server/pulls)

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)



---

 Few lines describing your project.

    
 



## 📝 Table of Contents

-   [About](#about)

-   [Getting Started](#getting_started)

-   [Deployment](#deployment)

-   [Usage](#usage)

-   [Built Using](#built_using)

-   [TODO](./docs/TODO.md)

-   [Contributing](../CONTRIBUTING.md)

-   [Authors](#authors)

-   [Acknowledgments](#acknowledgement)

## 🧐 About 

Write about 1-2 paragraphs describing the purpose of your project.

## 🏁 Getting Started 

### Prerequisites

#### install nvm

```sh

# use curl to install nvm

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.34.0/install.sh | bash

# or wget

wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.34.0/install.sh | bash

```

and make it work

```sh

soure ~/.bashrc

# if you use zsh

soure ~/.zshrc

```

#### install nodejs and npm

```sh

nvm install node

```

#### install pm2

```sh

sudo npm install -g pm2

```

### Installing

```sh

git clone https://github.com/bubao/keyboard-builder-server.git

cd keyboard-builder-server

npm install

pm2 start index.js -n builder-server

```

if you want to start the server when system is booted.

```sh

pm2 save

pm2 startup

```

## 🔧 Running the tests 

no tests to run.

## 🎈 Usage 

## 🚀 Deployment 

## ⛏️ Built Using 

-   [Express](https://expressjs.com/) - Server Framework

-   [NodeJs](https://nodejs.org/en/) - Server Environment

-   [body-parser](https://nodejs.org/en/) - Node.js Body Parsing Middleware

## ✍️ Authors 

-   [@bubao](https://github.com/bubao) - Initial work

## 🎉 Acknowledgements