Topsite Application
There are many different topsite applications out there, but none that are open source that have a range of features, we aim to address this, so whether it's a PBBG topsite, Minecraft topsite or any other topsite we aim to be to go solution
Getting Started
First step is the clone the repo
git clone [email protected]:pbbg/topsite.git
Copying and editing the .env
is next, user accounts require verification so SMTP is also needed, we recommend MailGun.
cp .env.example .env
Edit the DB_* details, MAIL_* settings
Next run the following
composer install
php artisan key:generate
php artisan migrate:fresh --seed
yarn
yarn prod (or yarn watch for development)
--seed
on migrate is optional if you want to have sample data
Prerequisites
What things you need to install the software and how to install them
PHP 7.3
MySQL/MariaDB
Yarn or NPM
Running the tests
We use PHPUnit for tests
./vendor/bin/phpunit
Built With
- Laravel - The web framework used
- SB Admin 2 - Front end template for the administration panel
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 tags on this repository.
Authors
License
This project is licensed under the MIT License - see the LICENSE.md file for details