From 80898e5feca383f4c794d7f15b8a032c21a4a60f Mon Sep 17 00:00:00 2001 From: Baterka <3463591+Baterka@users.noreply.github.com> Date: Tue, 17 Apr 2018 18:57:48 +0200 Subject: [PATCH] Readme edit --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ bot/logs/.gitignore | 4 ++++ 2 files changed, 49 insertions(+) diff --git a/README.md b/README.md index e69de29..f66a33f 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,45 @@ +# CSGOHunt.com - Copy + +Almost iodentical copy of [CSGOHunt.com](https://www.csgohunt.com/). Full NodeJS project. + +### Powered by + +* [Node.js](http://nodejs.org) +* [MariaDB](https://mariadb.org/) + +### Installation + +Requires [Node.js](https://nodejs.org/) 8+ and [MariaDB](https://mariadb.org/) 10.2+ database to run. + +Install the dependencies: + +```sh +$ npm install +``` + +Rename [config.index.js](https://github.com/Baterka/CSGOHunt.com-Copy/blob/master/config/index.example.js) file to index.js and fill all required data. + +Start website: + +```sh +$ node bin/www +``` + +Start servers: + +```sh +$ node servers/[jackpot|coinflip|chat].js +``` + +Start bots: + +```sh +$ node bot/[jackpot|coinflip].js +``` + +I recommend using [pm2](https://github.com/Unitech/pm2) for managing bot. + +### Todos + - Code revision + - Testing + - Rewrite to Non-relational database (MongoDB) \ No newline at end of file diff --git a/bot/logs/.gitignore b/bot/logs/.gitignore index e69de29..86d0cb2 100644 --- a/bot/logs/.gitignore +++ b/bot/logs/.gitignore @@ -0,0 +1,4 @@ +# Ignore everything in this directory +* +# Except this file +!.gitignore \ No newline at end of file