restheart-notes-example

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

restheart-notes-example

★ 12 Open GitHub ↗

Example notes application built with RESTHeart, AngularJS and restangular

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# restheart-notes-example

An example notes application built with RESTHeart, AngularJS and MongoDB.

## Clone this repository locally

$ git clone git@github.com:SoftInstigate/restheart-notes-example.git
	$ cd restheart-notes-example

## Install mongodb and RESTHeart

For detailed installation instructions refer to the [documentation](http://restheart.org/docs/get-up-and-running.html).

However the quickest way is using the **docker-compose.yml** in restheat's  distribution:

https://github.com/SoftInstigate/restheart/tree/master/Docker

Clone the [restheart repo](https://github.com/SoftInstigate/restheart/) and cd into the Docker folder, then:

$ docker-compose up -d

After the docker mongodb and restheart containers are started in background, you can check the logs:

$ docker-compose logs -f

## Create the data model

We will be using the RESTHeart API with [httpie](http://httpie.org) (you can also use another http client such as curl)

$ http -a admin:changeit PUT http://localhost:8080/rhnedb descr="restheart notes example db"
	
	HTTP/1.1 201 Created
	...
	
	$ http -a admin:changeit PUT http://localhost:8080/rhnedb/notes descr="notes collection"
	
	HTTP/1.1 201 Created
	...

## Start the Web app

First of all you need Node.js for your system [https://nodejs.org](https://nodejs.org).

Then install [Grunt](http://gruntjs.com/getting-started) and [Bower](http://bower.io):

npm install -g bower grunt-cli

Run `npm install` to install project dependencies:

npm install

Optionally, install compass (you must have ruby properly installed in your system):

gem update --system
	gem install compass

Run `bower install`. If Bower asks you for the AngularJS version, choose the most recent.

bower install

If you want to preview the web application, run `grunt serve`; after few seconds it should open the default browser at [http://localhost:9000/](http://localhost:9000/).

grunt serve

If you don't have compass installed then you'll get an error message, in this case just use `grunt serve --force` to continue.

To login in the Web app, you can use the **admin** user with password **changeit**

For more information on RESTHeart' security refer to the [documentation](http://restheart.org/docs/security.html).

## Testing

Running `grunt test` will run the unit tests with karma.

_Made with :heart: by [The SoftInstigate Team](http://www.softinstigate.com/). Follow us on [Twitter](https://twitter.com/softinstigate)_.

restheart-notes-example

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README