rayriffy / maimai-wiki

maimai Wiki Site

maiWiki

Requirements

• PHP 7.1.3+
• Composer
• MySQL 5.7+
• Node 8.11.1+

PS. We reccomended using yarn for Node package manager

Setting Up

• Config your own .env from .env.example
• composer install
• npm install or yarn
• npm run prod or npm run prod
• php artisan migrate
• php artisan db:seed to get a sample data

Contributing

We welcome all contributions by sending PR to this repository.

Need Help ?

If you need help with anything, here're following methods:

Create an Issue

If you have something you want to discuss in detail, or have hit an issue which you believe others will also have in deployment or development of the system, opening an issue is the best way to get help. It creates a permanent resource for others wishing to contribute to conversation.

License

maiWiki is licensed under MIT license. Please see the licence file for more information. tl;dr if you want to use any code, design or artwork from this project, attribute it and make your project open source under the same licence.