identor / trenchdevs

TrenchDevs Repo

Main source code for https://trenchdevs.org. TrenchDevs believes in outcome-based learning and adapting to different technologies by creating purposeful projects.

For more information please refer the "Launching TrenchDevs!!!" post.

Installation

Requirements

• Php 7.4+
• MySQL (Preferably MySQL 8)
• composer (https://getcomposer.org)

Quickstart

• Clone the repo: git clone https://github.com/trenchdevs/trenchdevs.git
• Navigate to directory: cd trenchdevs
• Install php dependencies: composer install
• Install npm dependencies: npm install
• Create database on MySQL: sql - create database trenchdevs
• Clone sample .env file: cp .env.example .env
• Modify .env for local system
• Generate Laravel key: php artisan key:generate
• Generate JWT key: php artisan jwt:secret
• Migrate the database tables: php artisan migrate
• Initial Data: php artisan db:seed
• Initialize projects data: php artisan utilities:execute initialize_project_data
• Start server: php artisan serve
• Using the default .env copied. On browser these two endponts should worl:
  • http://localhost:8000
  • blog.localhost:8000
• To sign in using the default user:
  • http://localhost:8000/login
  • email: [e-mail]
  • password: password

Note: All file uploads and email will not work by default. Please contact us at [e-mail] to help you setup these features locally.

Running App in Docker

A Docker image for the app is hosted in Docker hub. An example for running the image in docker with MySQL is provided in this section. Before proceeding, make sure you have ran through Quickstart. The .env generated will be needed for you to proceed. Instructions are tested in a linux shell, but should be compatible with any other Posix compliant shell.

Requirements

• docker
• docker-compose
• Posix compliant shell

If you don't have mysql installed locally on your machine, you could run it using docker-compose. Do note that the database instance used here will use tmpfs (in memory storage), stopping the service will delete data in MySQL.

$ docker-compose up db

Copy your .env file to .env.docker

$ cp .env .env.docker

Run the app with the following command:

$ docker run -p 8000:80 --env-file=.env.docker trenchdevs/trenchdevs

Code of Conduct

In order to ensure that the TrenchDevs community is welcoming to all, please review and abide by the Code of Conduct.

Security Issues

For security issues, please send an email to Christopher Espiritu via [e-mail] Security vulnerabilities will be addressed immediately.

License

The TrenchDevs App is open-sourced software under the Apache-2.0 License