Skip to content
This repository has been archived by the owner on Sep 5, 2017. It is now read-only.

Latest commit

 

History

History
executable file
·
223 lines (138 loc) · 10.8 KB

readme.md

File metadata and controls

executable file
·
223 lines (138 loc) · 10.8 KB
Raw

OrgManager

Build Status Code Coverage GitHub release license Codacy grade Packagist

OrgManager takes Github Organization invites to a new level! Read more about OrgManager on Medium.

Hosted version

Not everyone can afford a server, nor do they have the skills to set up a modern PHP application, so OrgManager provides a hosted version you can use for FREE. You can access the hosted version at https://orgmanager.miguelpiedrafita.com. In return, please report any bugs you encounter, so we can continue improving!

On joining the OrgManager Github organization

As you may have guessed, you can use OrgManager to join the OrgManager organization.

Development version

These instructions will get you the beta version of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

To install OrgManager you'll need:

Installing

Now that you've verified that you have that, let's start...

  1. Download beta version (Just clone the master branch)

Just open your terminal/console and run

git clone https://github.com/orgmanager/orgmanager

and you'll have the beta version on your new orgmanager folder.

  1. Add OrgManager to your server.

Just google instructions for your server. If you're using hotel, just open the OrgManager folder with the terminal/console and run

hotel add 'php artisan serve --port $PORT'

Now, if you configured custom domains, you can now access orgmanager.{yourtld}. If you didn't, access localhost:2000 and click OrgManager. Yeah, it should be showing that huge error, don't worry 😄

  1. Setup .env

Copy the .env.example file to a .env file. Open the .env file with your favorite text editor/IDE and fill the database, reCaptcha and GitHub settings. (You can leave the rest as they are)

  1. Finish the setup

Open the OrgManager folder with the terminal/console and run

php artisan key:generate && php artisan migrate
  1. Done!

You have now the OrgManager beta version up an running in your server! (Note that OrgManager is not auto-updated, read the updating section for more info).

Testing

We use the Laravel testing functionalities and PHPUnit to add automated testing to OrgManager.

Setting up the testing enviroment

By default, the tests will run in a special database called orgmanager_test in localhost with username root and password root. If you need to change this, edit the .env.testing file. This is an example of a customized .env.testing file:

APP_ENV=testing
APP_KEY=base64:GIkaQ57IIVtTeTQOIh7eAFo1FAcoWkfwYPkfcOyusW4=

DB_CONNECTION=travis

DB_TEST_HOST=database_host
DB_TEST_DATABASE=database_name
DB_TEST_USERNAME=database_username
DB_TEST_PASSWORD=database_password

CACHE_DRIVER=array
SESSION_DRIVER=array
QUEUE_DRIVER=sync

Once you've customized your .env.testing file, you have to migrate the database to your test database. You can do this by running php artisan migrate --env=testing.

To run the tests, just run composer test.

Deployment

These instructions will get you the lastest stable version of the project up and running on your server for production purposes. See the development version section for notes on how to setup the beta version on your local machine.

Prerequisites

To install OrgManager you'll need:

  • A web server of your choice - (We recommend Apache or Nginx for production, but any web server you have should work).
  • PHP - (At least v5.6.4, although v7.* is recommended. Installing PHP)
  • Some PHP libraries - (OpenSSL, PDO, Mbstring, Tokenizer, XML) (Google is your friend 😄)
  • Composer - (Install Composer)
  • MySQL database - (Although this isn't recommended for a production enviroment, you can get them online for free)
  • SSH access to your server (physical access is also valid)

Installing

Now that you've verified that you have that, let's start...

  1. Download lastest stable version

Download the lastest release and unzip it on your server.

  1. Add OrgManager to your server.

Just google instructions for your server. Yeah, it should be showing that huge error after setup, don't worry 😄

  1. Setup .env

Copy the .env.example file to a .env file. Open the .env file with your favorite text editor/IDE and fill the database, reCaptcha and GitHub settings. (You can leave the rest as they are, although it is recommended setting up Bugsnag in production).

REMEMBER TO SET DEBUG TO FALSE, AND TO CHANGE APP_ENV TO PROD IF THEY AREN'T!

  1. Finish the setup

Open the OrgManager folder with the terminal/console and run

composer install

and

php artisan key:generate && php artisan migrate
  1. Done!

You have now the lastest OrgManager stable version up an running in your server! (Note that OrgManager is not auto-updated, read the updating section for more info).

Updating

OrgManager is under active development, and that means it gets lots of updates, bug fixes and new features. Follow the guides below to update OrgManager to the lastest version:

Updating a development enviroment

This is the easiest one.

  1. Get lastest code

Open the orgmanager folder in the terminal/console and run

git pull origin master

and you're done.

FOR NEW RELEASES, REMEMBER TO CHECK THE UPGRADING GUIDE, IF ANY. YOU CAN FIND IT IN THE RELEASES PAGE.

Updating a production enviroment

New features deserve it, go ahead!

  1. Download lastest stable version

Download the lastest release and unzip it on your server.

REMEMBER TO FOLLOW THE UPGRADING GUIDE, IF ANY. YOU CAN FIND IT IN THE RELEASE PAGE.

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the releases page.

Support Channels

Facing an issue? Want to meet other OrgManager users? Just want to say hello?

Here are the official support channels we provide:

  • Github Issues - You can open an issue for things like requesting new features or reporting bugs.
  • Hosted Version Chat - If you've used the hosted version, you might have noticed that there is a chat icon on the bottom right corner. That chat is used for things related to the hosted version.
  • Gittler chat - We have a little Gitter chatroom for discussing things about the project, meeting other users and anything else you think of. Don't be afraid to say hello!
  • Email - You can send a mail to [email protected] to discuss anything with the main developer, Miguel Piedrafita.

Sponsors

Does your organization use OrgManager? Ask your manager or marketing team if you're interested in supporting our project. Support will allow the maintainers to dedicate more time for maintenance and new features for everyone. Also, your company's logo will show on GitHub and on our site --who doesn't want a little extra exposure?

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the Mozilla Public License - see the LICENSE.md file for details

Acknowledgments