Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/CityOfZion/dAppTemplate_MEAN

This template is designed to accelerate dApp development on the neo blockchain by providing a full-stack scaffold that runs and interfaces with fullnodes
https://github.com/CityOfZion/dAppTemplate_MEAN

Last synced: about 2 months ago
JSON representation

This template is designed to accelerate dApp development on the neo blockchain by providing a full-stack scaffold that runs and interfaces with fullnodes

Awesome Lists containing this project

README 

        


  




dApp Template: MEAN





  A dApp template for the NEO blockchain built on the MEAN stack.




*note: This template is based on the meanjs project found [here](https://github.com/meanjs/mean)



## Deployment ##



### Cloning The GitHub Repository

The recommended way to get this template is to use git to directly clone the the repository:



```bash

$ git clone https://github.com/CityOfZion/dAppTemplate_MEAN.git myProject

```



This will clone the latest version of the MEAN.JS repository to a **myProject** folder.



## Quick Install

Once you've cloned the repo and installed all the prerequisites, you're just a few steps away from interfacing with the neo blockchain and building your application.



The boilerplate comes pre-bundled with a `package.json` and `bower.json` files that contain the list of modules you need to start your application.



To install the dependencies, run this in the application folder from the command-line:



```bash

$ npm install

```



This command does a few things:

* First it will install the dependencies needed for the application to run.

* If you're running in a development environment, it will then also install development dependencies needed for testing and running your application.

* When the npm packages install process is over, npm will initiate a bower install command to install all the front-end modules needed for the application

* To update these packages later on, just run `npm update`



## Running Your Application



Run your application using npm:



```bash

$ npm start

```



Your application should run on port 3000 with the *development* environment configuration, so in your browser just go to [http://localhost:3000](http://localhost:3000)



That's it! Your application should be running. To proceed with your development, check the other sections in this documentation.

If you encounter any problems, try the Troubleshooting section.



Explore `config/env/development.js` for development environment configuration options.



*Note: development mode will sync to the testnet and production mode will sync to mainnet.  Parallel syncronization is not currently supported.  



### Running in Production mode

To run your application with *production* environment configuration:



```bash

$ npm run start:prod

```



Explore `config/env/production.js` for production environment configuration options.



### Running with User Seed

To have default account(s) seeded at runtime:



In Development:

```bash

MONGO_SEED=true npm start

```

It will try to seed the users 'user' and 'admin'. If one of the user already exists, it will display an error message on the console. Just grab the passwords from the console.



In Production:

```bash

MONGO_SEED=true npm start:prod

```

This will seed the admin user one time if the user does not already exist. You have to copy the password from the console and save it.



### Running with TLS (SSL)

Application will start by default with secure configuration (SSL mode) turned on and listen on port 8443.

To run your application in a secure manner you'll need to use OpenSSL and generate a set of self-signed certificates. Unix-based users can use the following command:



```bash

$ npm run generate-ssl-certs

```



Windows users can follow instructions found [here](http://www.websense.com/support/article/kbarticle/How-to-use-OpenSSL-and-Microsoft-Certification-Authority).

After you've generated the key and certificate, place them in the *config/sslcerts* folder.



Finally, execute prod task `npm run start:prod`

* enable/disable SSL mode in production environment change the `secure` option in `config/env/production.js`



## Testing Your Application

You can run the full test suite included with MEAN.JS with the test task:



```bash

$ npm test

```

This will run both the server-side tests (located in the `app/tests/` directory) and the client-side tests (located in the `public/modules/*/tests/`).



To execute only the server tests, run the test:server task:



```bash

$ npm run test:server

```



To execute only the server tests and run again only changed tests, run the test:server:watch task:



```bash

$ npm run test:server:watch

```



And to run only the client tests, run the test:client task:



```bash

$ npm run test:client

```



## Running your application with Gulp



The MEAN.JS project integrates Gulp as build tools and task automation.



We have wrapped Gulp tasks with npm scripts so that regardless of the build tool running the project is transparent to you.



To use Gulp directly, you need to first install it globally:



```bash

$ npm install gulp -g

```



Then start the development environment with:



```bash

$ gulp

```



To run your application with *production* environment configuration, execute gulp as follows:



```bash

$ gulp prod

```



It is also possible to run any Gulp tasks using npm's run command and therefore use locally installed version of gulp, for example: `npm run gulp eslint`



## Development and deployment With Docker



* Install [Docker](https://docs.docker.com/installation/#installation)

* Install [Compose](https://docs.docker.com/compose/install/)



* Local development and testing with compose:

```bash

$ docker-compose up

```



* Local development and testing with just Docker:

```bash

$ docker build -t mean .

$ docker run -p 27017:27017 -d --name db mongo

$ docker run -p 3000:3000 --link db:db_1 mean

$

```



* To enable live reload, forward port 35729 and mount /app and /public as volumes:

```bash

$ docker run -p 3000:3000 -p 35729:35729 -v /Users/mdl/workspace/mean-stack/mean/public:/home/mean/public -v /Users/mdl/workspace/mean-stack/mean/app:/home/mean/app --link db:db_1 mean

```



### Production deploy with Docker



* Production deployment with compose:

```bash

$ docker-compose -f docker-compose-production.yml up -d

```



* Production deployment with just Docker:

```bash

$ docker build -t mean -f Dockerfile-production .

$ docker run -p 27017:27017 -d --name db mongo

$ docker run -p 3000:3000 --link db:db_1 mean

```



## Getting Started With MEAN.JS

You have your application running, but there is a lot of stuff to understand. We recommend you go over the [Official Documentation](http://meanjs.org/docs.html).

In the docs we'll try to explain both general concepts of MEAN components and give you some guidelines to help you improve your development process. We tried covering as many aspects as possible, and will keep it updated by your request. You can also help us develop and improve the documentation by checking out the *gh-pages* branch of this repository.



## Community

* Use the [Official Website](http://meanjs.org) to learn about changes and the roadmap.

* Join #meanjs on freenode.

* Discuss it in the new [Google Group](https://groups.google.com/d/forum/meanjs)

* Ping us on [Twitter](http://twitter.com/meanjsorg) and [Facebook](http://facebook.com/meanjs)



## Contributing

We welcome pull requests from the community! Just be sure to read the [contributing](https://github.com/meanjs/mean/blob/master/CONTRIBUTING.md) doc to get started.



## Credits

Inspired by the great work of [Madhusudhan Srinivasa](https://github.com/madhums/)

The MEAN name was coined by [Valeri Karpov](http://blog.mongodb.org/post/49262866911/the-mean-stack-mongodb-expressjs-angularjs-and).



## License

[The MIT License](LICENSE.md)