This repository provides a docker configuration so you can start contributing quickly. Joind.in is a big project, so there a few parts involved.
Joind.in welcomes all contributors regardless of your ability or experience. We especially welcome you if you are new to Open Source development and will provide a helping hand. To ensure that everyone understands what we expect from our community, our projects have a Contributor Code of Conduct and by participating in the development of joind.in you agree to abide by its terms.
Install requirements. (Note: these are not required by joind.in itself, but are required for this quick start guide.)
- Docker
- Docker-compose
- Composer (https://getcomposer.org/)
-
Make your own github fork of the following joind.in repositories:
-
Clone joindin-docker
Make sure that you are accessing your fork of the joindin-docker repo
git clone git@github.com:{YourGitHubId}/joindin-docker.git --recursive
For example:
git clone git@github.com:defunkt/joindin-docker.git --recursive
-
Execute the script that will clone the other 2 repositories from your forks
cd joindin-docker php scripts/cloneRepository.php
-
Start the containers
docker-compose build docker-compose up
-
Install the database
docker-compose exec api /var/www/html/scripts/patchdb.sh -t /var/www/html/ -d joindin -u root -p joindin -i
-
Update the configuration
scripts/fixConfig.sh
-
Open the sites in your browser
-
You can log in to the joind.in test site with these credentials for an admin account:
- Username: imaadmin
- Password: password
-
For other users, look at the dbgen documentation.
-
Accessing the database The api's database is exposed externally on port 33060
-
Emails The images use mailhog to catch outgoing email. the mailhog interface can be accessed through localhost:8025
Happy coding!!!