Skip to content

Commit

Permalink
Finish core conversion
Browse files Browse the repository at this point in the history
- Convert seeding
- Convert User server-side testing
- Modify “welcome” 
- Modify README and CONTRIBUTE
  • Loading branch information
francisdaigle committed Jan 15, 2016
1 parent 4add04d commit f5bbc0a
Show file tree
Hide file tree
Showing 26 changed files with 1,612 additions and 2,019 deletions.
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
@@ -1,14 +1,14 @@
# How to contribute

Support and contributions from the open source community are essential for keeping
MEAN.js up to date and always improving! There are a few guidelines that we need
PEAN.js up to date and always improving! There are a few guidelines that we need
contributors to follow to keep the project consistent, as well as allow us to keep
maintaining MEAN.js in a reasonable amount of time.
maintaining PEAN.js in a reasonable amount of time.

## Creating an Issue

Before you create a new Issue:
* Check the [Issues](https://github.com/meanjs/mean/issues) on Github to ensure one doesn't already exist.
* Check the [Issues](https://github.com/StetSolutions/pean/issues) on Github to ensure one doesn't already exist.
* Clearly describe the issue, including the steps to reproduce the issue.
* If it's a new feature, enhancement, or restructure, Explain your reasoning on why you think it should be added, as well as a particular use case.

Expand Down Expand Up @@ -52,7 +52,7 @@ Fixes #82
```

* Types:
* feat - Features, Enhancements, and overall Improvements
* feature - Features, Enhancements, and overall Improvements
* fix - Fixes, Bugs, HotFixs, etc...
* doc - Changes to the Documentation and doesn't actually touch any code.
* Scope:
Expand All @@ -68,15 +68,15 @@ Fixes #82
## Submitting the Pull Request

* Push your changes to your topic branch on your fork of the repo.
* Submit a pull request from your topic branch to the master branch on the MEAN.JS repository.
* Submit a pull request from your topic branch to the master branch on the PEAN.JS repository.
* Be sure to tag any issues your pull request is taking care of / contributing to.
* By adding "Closes #xyz" to a commit message will auto close the issue once the pull request is merged in.
* Small changes are usually accepted and merged in within a week (provided that 2 collaborators give the okay)
* Larger changes usually spark further discussion and possible changes prior to being merged in.

## Documentation (meanjs.org)
## Documentation

The code for the documentation and the website are located in the meanjs/mean repo on the gh-pages branch. The website is hosted by github pages and generated using jekyll. See the README in the gh-pages branch for more information on how to get your dev enviorment set-up.
PEAN Wiki. Wikis provide a place in your repository to lay out the roadmap of your project, show the current status, and document software better, together.

## Generating a new Release

Expand Down
110 changes: 38 additions & 72 deletions README.md
@@ -1,15 +1,10 @@
[![MEAN.JS Logo](http://meanjs.org/img/logo-small.png)](http://meanjs.org/)
#PEAN.JS

[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/meanjs/mean?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Build Status](https://travis-ci.org/meanjs/mean.svg?branch=master)](https://travis-ci.org/meanjs/mean)
[![Dependencies Status](https://david-dm.org/meanjs/mean.svg)](https://david-dm.org/meanjs/mean)
[![Coverage Status](https://coveralls.io/repos/meanjs/mean/badge.svg?branch=master&service=github)](https://coveralls.io/github/meanjs/mean?branch=master)

MEAN.JS is a full-stack JavaScript open-source solution, which provides a solid starting point for [MongoDB](http://www.mongodb.org/), [Node.js](http://www.nodejs.org/), [Express](http://expressjs.com/), and [AngularJS](http://angularjs.org/) based applications. The idea is to solve the common issues with connecting those frameworks, build a robust framework to support daily development needs, and help developers use better practices while working with popular JavaScript components.
PEAN.JS is a full-stack JavaScript open-source solution, which provides a solid starting point for [PostgreSQL](http://www.postgresql.org/), [Node.js](http://www.nodejs.org/), [Express](http://expressjs.com/), and [AngularJS](http://angularjs.org/) based applications. The idea is to solve the common issues with connecting those frameworks, build a robust framework to support daily development needs, and help developers use better practices while working with popular JavaScript components.

## Before You Begin
Before you begin we recommend you read about the basic building blocks that assemble a MEAN.JS application:
* MongoDB - Go through [MongoDB Official Website](http://mongodb.org/) and proceed to their [Official Manual](http://docs.mongodb.org/manual/), which should help you understand NoSQL and MongoDB better.
Before you begin we recommend you read about the basic building blocks that assemble a PEAN.JS application:
* PostgreSQL - Go through [PostegreSQL Official Website](http://www.postgresql.org/) and proceed to their [Official Documentation](http://www.postgresql.org/docs/), which should help you understand PostgreSQL better.
* Express - The best way to understand express is through its [Official Website](http://expressjs.com/), which has a [Getting Started](http://expressjs.com/starter/installing.html) guide, as well as an [ExpressJS Guide](http://expressjs.com/guide/error-handling.html) guide for general express topics. You can also go through this [StackOverflow Thread](http://stackoverflow.com/questions/8144214/learning-express-for-node-js) for more resources.
* AngularJS - Angular's [Official Website](http://angularjs.org/) is a great starting point. You can also use [Thinkster Popular Guide](http://www.thinkster.io/), and the [Egghead Videos](https://egghead.io/).
* Node.js - Start by going through [Node.js Official Website](http://nodejs.org/) and this [StackOverflow Thread](http://stackoverflow.com/questions/2353818/how-do-i-get-started-with-node-js), which should get you going with the Node.js platform in no time.
Expand All @@ -19,7 +14,7 @@ Before you begin we recommend you read about the basic building blocks that asse
Make sure you have installed all of the following prerequisites on your development machine:
* Node.js - [Download & Install Node.js](https://nodejs.org/en/download/) and the npm package manager. If you encounter any problems, you can also use this [GitHub Gist](https://gist.github.com/isaacs/579814) to install Node.js.
* Node v5 IS NOT SUPPORTED AT THIS TIME!
* MongoDB - [Download & Install MongoDB](http://www.mongodb.org/downloads), and make sure it's running on the default port (27017).
* PostgreSQL - [Download & Install PostegreSQL](http://www.postgresql.org/download/).
* Ruby - [Download & Install Ruby](https://www.ruby-lang.org/en/documentation/installation/)
* Bower - You're going to use the [Bower Package Manager](http://bower.io/) to manage your front-end packages. Make sure you've installed Node.js and npm first, then install bower globally using npm:

Expand Down Expand Up @@ -49,32 +44,29 @@ $ npm install -g grunt-cli
$ npm install gulp -g
```

## Downloading MEAN.JS
There are several ways you can get the MEAN.JS boilerplate:
## Downloading PEAN.JS
There are several ways you can get the PEAN.JS boilerplate:

### Cloning The GitHub Repository
The recommended way to get MEAN.js is to use git to directly clone the MEAN.JS repository:
The recommended way to get PEAN.js is to use git to directly clone the PEAN.JS repository:

```bash
$ git clone https://github.com/meanjs/mean.git meanjs
$ git clone https://github.com/StetSolutions/pean.git peanjs
```

This will clone the latest version of the MEAN.JS repository to a **meanjs** folder.
This will clone the latest version of the PEAN.JS repository to a **peanjs** folder.

### Downloading The Repository Zip File
Another way to use the MEAN.JS boilerplate is to download a zip copy from the [master branch on GitHub](https://github.com/meanjs/mean/archive/master.zip). You can also do this using `wget` command:
Another way to use the PEAN.JS boilerplate is to download a zip copy from the [master branch on GitHub](https://github.com/StetSolutions/pean/archive/master.zip). You can also do this using `wget` command:

```bash
$ wget https://github.com/meanjs/mean/archive/master.zip -O meanjs.zip; unzip meanjs.zip; rm meanjs.zip
$ wget https://github.com/StetSolutions/pean/archive/master.zip -O peanjs.zip; unzip peanjs.zip; rm peanjs.zip
```

Don't forget to rename **mean-master** after your project name.

### Yo Generator
Another way would be to use the [Official Yo Generator](http://meanjs.org/generator.html), which generates a copy of the MEAN.JS 0.4.x boilerplate and supplies an application generator to ease your daily development cycles.
Don't forget to rename **pean-master** after your project name.

## Quick Install
Once you've downloaded the boilerplate and installed all the prerequisites, you're just a few steps away from starting to develop your MEAN application.
Once you've downloaded the boilerplate and installed all the prerequisites, you're just a few steps away from starting to develop your PEAN application.

The first thing you should do is install the Node.js dependencies. The boilerplate comes pre-bundled with a package.json file that contains the list of modules you need to start your application. To learn more about the modules installed visit the NPM & Package.json section.

Expand Down Expand Up @@ -117,13 +109,13 @@ To have default account(s) seeded at runtime:

In Development:
```bash
MONGO_SEED=true grunt
DB_SEED=true grunt
```
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 grunt prod
DB_SEED=true grunt 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.

Expand All @@ -143,7 +135,7 @@ Finally, execute grunt's prod task `grunt prod`


## Testing Your Application
You can run the full test suite included with MEAN.JS with the test task:
You can run the full test suite included with PEAN.JS with the test task:

```bash
$ grunt test
Expand Down Expand Up @@ -194,7 +186,7 @@ $ gulp prod
```

### Testing Your Application with Gulp
Using the full test suite included with MEAN.JS with the test task:
Using the full test suite included with PEAN.JS with the test task:

### Run all tests
```bash
Expand All @@ -216,83 +208,57 @@ gulp test:client
gulp test:e2e
```

## 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
```

## 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).
## Getting Started With PEAN.JS
You have your application running, but there is a lot of stuff to understand. We recommend you go over the [Official MEAN 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)
* Use the [Official Website](http://peanjs.org) to learn about changes and the roadmap.

## 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.
We welcome pull requests from the community! Just be sure to read the [contributing](https://github.com/StetSolutions/pean/blob/master/CONTRIBUTING.md) doc to get started.

## Deploying To Cloud Foundry

Cloud Foundry is an open source platform-as-a-service (PaaS). The MEANJS project
Cloud Foundry is an open source platform-as-a-service (PaaS). The PEANJS project
can easily be deployed to any Cloud Foundry instance. The easiest way to deploy the
MEANJS project to Cloud Foundry is to use a public hosted instance. The two most popular
PEANJS project to Cloud Foundry is to use a public hosted instance. The two most popular
instances are [Pivotal Web Services](https://run.pivotal.io/) and
[IBM Bluemix](https://bluemix.net). Both provide free trials and support pay-as-you-go models
for hosting applications in the cloud. After you have an account follow the below steps to deploy MEANJS.
for hosting applications in the cloud. After you have an account follow the below steps to deploy PEANJS.

* Install the [Cloud Foundry command line tools](http://docs.cloudfoundry.org/devguide/installcf/install-go-cli.html).
* Now you need to log into Cloud Foundry from the Cloud Foundry command line.
* If you are using Pivotal Web Services run `$ cf login -a api.run.pivotal.io`.
* If you are using IBM Bluemix run `$ cf login -a api.ng.bluemix.net`.
* Create a Mongo DB service.
+ * If you are using Pivotal Web Services run `$ cf create-service mongolab sandbox mean-mongo`
+ * If you are using IBM Bluemix run `$ cf create-service mongodb 100 mean-mongo`
* Clone the GitHub repo for MEANJS if you have not already done so
* `$ git clone https://github.com/meanjs/mean.git && cd mean`
+ * If you are using Pivotal Web Services run `$ cf create-service mongolab sandbox pean-mongo`
+ * If you are using IBM Bluemix run `$ cf create-service mongodb 100 pean-mongo`
* Clone the GitHub repo for PEANJS if you have not already done so
* `$ git clone https://github.com/StetSolutions/pean.git && cd pean`
* Run `$ npm install`
* Run the Grunt Build task to build the optimized JavaScript and CSS files
* `$ grunt build`
* Deploy MEANJS to Cloud Foundry
* Deploy PEANJS to Cloud Foundry
* `$ cf push`

After `cf push` completes you will see the URL to your running MEANJS application
After `cf push` completes you will see the URL to your running PEANJS application
(your URL will be different).

requested state: started
instances: 1/1
usage: 128M x 1 instances
urls: mean-humbler-frappa.mybluemix.net
urls: pean-humbler-frappa.mybluemix.net

Open your browser and go to that URL and your should see your MEANJS app running!
Open your browser and go to that URL and your should see your PEANJS app running!

### Deploying MEANJS To IBM Bluemix
### Deploying PEANJS To IBM Bluemix
IBM Bluemix is a Cloud Foundry based PaaS. By clicking the button below you can signup for Bluemix and deploy
a working copy of MEANJS to the cloud without having to do the steps above.
a working copy of PEANJS to the cloud without having to do the steps above.

[![Deploy to Bluemix](https://bluemix.net/deploy/button.png)](https://bluemix.net/deploy?repository=https%3A%2F%2Fgithub.com%2Fmeanjs%2Fmean)
[![Deploy to Bluemix](https://bluemix.net/deploy/button.png)](https://bluemix.net/deploy?repository=https%3A%2F%2Fgithub.com%2Fpeanjs%2Fpean)

After the deployment is finished you will be left with a copy of the MEANJS code in your own private Git repo
After the deployment is finished you will be left with a copy of the PEANJS code in your own private Git repo
in Bluemix complete with a pre-configured build and deploy pipeline. Just clone the Git repo, make your changes, and
commit them back. Once your changes are committed, the build and deploy pipeline will run automatically deploying
your changes to Bluemix.
Expand Down Expand Up @@ -321,4 +287,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2 changes: 1 addition & 1 deletion config/env/development.js
Expand Up @@ -75,7 +75,7 @@ module.exports = {
}
},
livereload: true,
roles: ['user', 'admin'],
roles: ['admin', 'guest', 'user'],
seedDB: {
seed: process.env.DB_SEED === 'true' ? true : false,
options: {
Expand Down
13 changes: 7 additions & 6 deletions config/env/production.js
Expand Up @@ -76,23 +76,24 @@ module.exports = {
}
}
},
roles: ['admin', 'guest', 'user'],
seedDB: {
seed: process.env.MONGO_SEED === 'true' ? true : false,
seed: process.env.DB_SEED === 'true' ? true : false,
options: {
logResults: process.env.MONGO_SEED_LOG_RESULTS === 'false' ? false : true,
logResults: process.env.DB_SEED_LOG_RESULTS === 'false' ? false : true,
seedUser: {
username: process.env.MONGO_SEED_USER_USERNAME || 'user',
username: process.env.DB_SEED_USER_USERNAME || 'user',
provider: 'local',
email: process.env.MONGO_SEED_USER_EMAIL || 'user@localhost.com',
email: process.env.DB_SEED_USER_EMAIL || 'user@localhost.com',
firstName: 'User',
lastName: 'Local',
displayName: 'User Local',
roles: ['user']
},
seedAdmin: {
username: process.env.MONGO_SEED_ADMIN_USERNAME || 'admin',
username: process.env.DB_SEED_ADMIN_USERNAME || 'admin',
provider: 'local',
email: process.env.MONGO_SEED_ADMIN_EMAIL || 'admin@localhost.com',
email: process.env.DB_SEED_ADMIN_EMAIL || 'admin@localhost.com',
firstName: 'Admin',
lastName: 'Local',
displayName: 'Admin Local',
Expand Down
22 changes: 11 additions & 11 deletions config/env/test.js
Expand Up @@ -4,13 +4,12 @@ var defaultEnvConfig = require('./default');

module.exports = {
db: {
uri: process.env.MONGOHQ_URL || process.env.MONGOLAB_URI || 'mongodb://' + (process.env.DB_1_PORT_27017_TCP_ADDR || 'localhost') + '/mean-test',
options: {
user: '',
pass: ''
name: '',
password: '',
user: ''
},
// Enable mongoose debug mode
debug: process.env.MONGODB_DEBUG || false
sync: true
},
log: {
// logging with Morgan - https://github.com/expressjs/morgan
Expand Down Expand Up @@ -76,23 +75,24 @@ module.exports = {
}
}
},
roles: ['admin', 'guest', 'user'],
seedDB: {
seed: process.env.MONGO_SEED === 'true' ? true : false,
seed: process.env.DB_SEED === 'true' ? true : false,
options: {
logResults: process.env.MONGO_SEED_LOG_RESULTS === 'false' ? false : true,
logResults: process.env.DB_SEED_LOG_RESULTS === 'false' ? false : true,
seedUser: {
username: process.env.MONGO_SEED_USER_USERNAME || 'user',
username: process.env.DB_SEED_USER_USERNAME || 'user',
provider: 'local',
email: process.env.MONGO_SEED_USER_EMAIL || 'user@localhost.com',
email: process.env.DB_SEED_USER_EMAIL || 'user@localhost.com',
firstName: 'User',
lastName: 'Local',
displayName: 'User Local',
roles: ['user']
},
seedAdmin: {
username: process.env.MONGO_SEED_ADMIN_USERNAME || 'admin',
username: process.env.DB_SEED_ADMIN_USERNAME || 'admin',
provider: 'local',
email: process.env.MONGO_SEED_ADMIN_EMAIL || 'admin@localhost.com',
email: process.env.DB_SEED_ADMIN_EMAIL || 'admin@localhost.com',
firstName: 'Admin',
lastName: 'Local',
displayName: 'Admin Local',
Expand Down

0 comments on commit f5bbc0a

Please sign in to comment.