Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/couchbaselabs/comply-nodejs
https://github.com/couchbaselabs/comply-nodejs
Last synced: 1 day ago
JSON representation
- Host: GitHub
- URL: https://github.com/couchbaselabs/comply-nodejs
- Owner: couchbaselabs
- Created: 2016-01-07T19:27:41.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-07-08T08:26:21.000Z (over 1 year ago)
- Last Synced: 2024-04-12T16:19:11.809Z (9 months ago)
- Language: TypeScript
- Size: 645 KB
- Stars: 11
- Watchers: 49
- Forks: 6
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CEAN Stack Project Tracking Application
This project is meant to demonstrate a full stack application using Couchbase, Express Framework, Angular 2, and Node.js. This particular stack is called the CEAN stack or CANE stack. With the Object Document Modeling (ODM) tool Ottoman, we can easily create relationships between documents within the application.
## Installation
Download or clone the project from GitHub and run the following via the Command Prompt (Windows) or Terminal (Mac and Linux):
```
npm install
cd angular
npm install
```
This will install all Node.js and Angular 2 dependencies into the project. With the dependencies available, the TypeScript files need to be compiled into their JavaScript version. This can be done by executing the following from the Terminal or Command Prompt:
```
cd angular
ng build --output-path=../public
```
If there were no compile time errors, you should be left with a **public** directory that will be picked up by Node.js when the project is run.
## Configuration
This project expects a Couchbase Server bucket to exist named **comply**. This bucket name can be changed in the project's **config.json** file.
## Running the Project
From the root of the project, in your Command Prompt or Terminal execute the following to run the Node.js backend:
```
node app.js
```
Because the Angular 2 TypeScript files were compiled in the installation step, and because they are bundled with the Node.js code, the application can be accessed via **http://localhost:3000**
## Resources
Couchbase Server - [http://www.couchbase.com](http://www.couchbase.com)
Ottoman - [http://ottomanjs.com](http://ottomanjs.com)
Couchbase Compliance Demo with Java - [https://github.com/couchbaselabs/comply-java](https://github.com/couchbaselabs/comply-java)
Couchbase Compliance Demo with GoLang - [https://github.com/couchbaselabs/comply-golang](https://github.com/couchbaselabs/comply-golang)