An open API service indexing awesome lists of open source software.

https://github.com/practical-works/0db-example

Example project for testing 0db.
https://github.com/practical-works/0db-example

Last synced: 9 months ago
JSON representation

Example project for testing 0db.

Awesome Lists containing this project

README

          

# 🌏 0db Example

[![Web](https://img.shields.io/badge/web-blue?logo=w3c)](https://github.com/topics/web)
[![JavaScript](https://img.shields.io/badge/javascript-blue?logo=javascript)](https://github.com/topics/javascript)
[![NodeJS](https://img.shields.io/badge/node-blue?logo=node.js)](https://github.com/topics/node)

Example project for testing [**0db**](https://github.com/Ambratolm/0db).

## 🏁 Getting started

1. Clone the repository:

```bash
cd somewhere
git clone https://github.com/practical-works/0db-example.git
cd express-sample
```

2. Install the dependencies:

```bash
npm i
```

3. Install [**Nodemon**](https://github.com/remy/nodemon/) globally:

```bash
npm i -g nodemon
```

4. Run server for development:

```bash
npm run dev
```

## ✈️ Deployment

To deploy the project in a node environment:

1. Push the repository to a node server using a service like [Heroku](https://heroku.com).

2. Install the dependencies:

```bash
npm i
```

3. Start server for production:

```bash
npm start
```

## 🚀 Development

### 🏭 Environment

- Runtime: [**NodeJS**](https://github.com/nodejs)
- Package Manager: [**NPM**](https://github.com/npm)
- Editor: [**Sublime Text**](https://www.sublimetext.com)

### 🌑 Backend

- ⚛️ Core:
- Main: [**NodeJS**](https://github.com/nodejs/node) / [**ExpressJS**](https://github.com/expressjs/express)
- Template Engine: [**EJS**](https://github.com/mde/ejs)
- 💽 Database: [**0db**](https://github.com/Ambratolm/0db)
- 🔧 Utils:
- Session Storage: [**Cookie-Session**](https://github.com/expressjs/cookie-session)
- YAML display: [**JSON2YAML**](https://github.com/coolaj86/json2yaml)
- Console Logging: [**Morgan**](https://github.com/expressjs/morgan)
- Hot Reloading: [**LiveReload**](https://github.com/napcs/node-livereload) / [**Connect-LiveReload**](https://github.com/intesso/connect-livereload)

### 🌕 Frontend

- 🎨 UI:
- Main: [**Bulma**](https://github.com/jgthms/bulma)
- Theme: [**Bulmaswatch**](https://github.com/jenil/bulmaswatch)

## 📃 License

Licensed under [MIT](./LICENSE).