opendor.me

This is the repository for the opendor.me. The code is entirely open source and licensed under CC BY-NC-SA 3.0 License. Read the installation guide below to get started with setting up the app on your machine.

Requirements

The following tools are required in order to start the installation.

• Docker
• Docker Compose
• Make

Installation

1. Clone this repository with git clone https://github.com/Astrotomic/opendor.me.git
2. Run cp .env.example .env to copy .env file
3. Run make setup to setup local environment
4. Run make start to start the application

Note: You can create your own phpunit.xml to customize your PhpUnit configuration.

Github Setup

To get Github authentication to work locally, you'll need to register a new OAuth application on Github. Use http://localhost:8080 for the homepage url and http://localhost:8000/auth/github/callback for the callback url. When you've created the app, fill in the ID and secret in your .env file in the env variables below. You should now be able to authentication with Github.

GITHUB_CLIENT_ID=
GITHUB_CLIENT_SECRET=

Commands

Command	Description
make composer-install	Install composer dependencies
make run <command>	Run the desire command inside container
make migrate	Run the migration
make test	Run the tests
make npm-dev	Build the dependencies
make npm-install	Install npm dependencies
make stop	Stop the running containers