Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/dj0nny/vue-nedb

Vue.js web app built with NeDB
https://github.com/dj0nny/vue-nedb

nedb vue vue-nedb vuejs vuex

Last synced: 2 months ago
JSON representation

Vue.js web app built with NeDB

Awesome Lists containing this project

README

        

# vue-nedb

[![Build Status](https://travis-ci.org/dj0nny/vue-nedb.svg?branch=develop)](https://travis-ci.org/dj0nny/vue-nedb)
[![npm version](https://badge.fury.io/js/vue.svg)](https://badge.fury.io/js/vue)
[![npm version](https://badge.fury.io/js/nedb.svg)](https://badge.fury.io/js/nedb)
[![vue](https://img.shields.io/badge/build%20with-vue-blue.svg)](https://img.shields.io/badge/build%20with-vue-blue.svg)
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/dwyl/esta/issues)

> CRUD client for NeDB built with Vue.js

## Getting Started

### Prerequisites

For this project you need [__Node__](https://nodejs.org/en/) installed on your machine with [__Npm__](https://www.npmjs.com/) or [__Yarn__](https://yarnpkg.com)

### Installing

You can clone this repository using __Git__:
```bash
git clone https://github.com/dj0nny/vue-nedb
```

Or download the repository [here](https://github.com/dj0nny/vue-nedb/archive/develop.zip)

---

Open a terminal and type, inside the directory:
```bash
npm install
# OR
yarn install
```

for installing all the dependencies. At the end type, in the same folder:
```bash
npm run serve
# OR
yarn serve
```
for running the Vue.js development server. It will be up and running at this address: http://localhost:8080.

## Deployment

You can also create a build version of this repository running the command:
```bash
npm run build
# OR
yarn build
```

## Next Version

- [x] Initial setup
- [x] Install NeDB
- [x] Vuex setup
- [x] Add pages and routes
- [x] Add components
- [x] Styling
- [x] Add new record form
- [x] Display records
- [x] Edit record

## Built with ❤️ using:

* [Vue.js](https://vuejs.org/) - A Javascript framework
* [NeDB](https://github.com/louischatriot/nedb) -The JavaScript Database
* [Vuex](https://vuex.vuejs.org/) - Centralized State Management for Vue.js

## Contributing

Pull Requests for adding features ⇄ and ★ are welcome 😎