diff --git a/README.md b/README.md index eb7e1b8..e438297 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,30 @@ -# csgo-mapvote +# discontinued +CSGO is discontinued and so is mapvote. + +## csgo-mapvote csgo-mapvote is a tool to reach a consensus on a CS:GO map pool while playing with friends. -## installation +### installation The tool relies on node.js and sqlite3 on server side and vuejs on the frontend. -### backend +#### backend Navigate into `backend` directory and run ```npm i``` to install node dependencies. Use `npm run dev` to start a development server. For a production environment use once `sqlite3 mapvotes.db` to create the database file and `npm run setupDB` to create the required tables. Afterwards start the server with `npm start`. -### frontend +#### frontend Navigate into `frontend` directory and run ```npm i``` to install node dependencies. Use `npm run serve` to start a development server. The backend must be running for the page to work properly. For production environment use `npm run build` to build the production files in the `dist` directory. Use a simple webserver to serve all files. -## contributing +### contributing We're happy about contributions. Feel free to fix bugs via PR. New features should be discussed in "Issues" with "enhancement" label. -## demo +### demo You can find a live demo at [https://mapvote.error401.de](https://mapvote.error401.de) ![screenshot](https://github.com/error401de/csgo-mapvote/blob/master/docu/screenshot.png?raw=true)