diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..a7bb263 --- /dev/null +++ b/.env.example @@ -0,0 +1,6 @@ +# MongoDB connection URI as set in police-cad .env +dbo=knoldus +mongoURI=mongodb://localhost/knoldus + +# Discord Bot Token +token= \ No newline at end of file diff --git a/.gitignore b/.gitignore index 2dc74ea..010edd6 100644 --- a/.gitignore +++ b/.gitignore @@ -1,17 +1,8 @@ # dependencies node_modules/* -# test file -default.js -test.js -default.js - -# Dev -config/dev-config.js -dev.js - -# Logs +# logs logs/* -Logs.log -.env \ No newline at end of file +# environment variables +.env diff --git a/README.md b/README.md index 25aef6a..0944df9 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,23 @@ ### Lines Police CAD Discord Bot + ![lines police cad logo](https://github.com/Linesmerrill/police-cad/blob/master/lines-police-cad.png) -This is the official Lines Police CAD bot for discord integration. It allows you to use Lines Police CAD website features right in your discord channel! +This is the official Lines Police CAD bot for Discord integration. ### Requirements : -1. [Node.js](https://nodejs.org/en/) -1. [MongoDB](https://docs.mongodb.com/manual/administration/install-community/) +1. [police-cad](https://github.com/LinesMerrill/police-cad) +2. [Node.js](https://nodejs.org/en/) +3. [MongoDB](https://docs.mongodb.com/manual/administration/install-community/) ### Getting Started with Code : -1. [Set Up MongoDB](#setting-up-mongodb) and start mongodb -2. Clone repo from https://github.com/SowinskiBraeden/LPC-Bot.git +1. Follow the [README.md](https://github.com/Linesmerrill/police-cad/blob/main/README.md) to setup an instance of the police-cad project. This will also include the setup of MongoDB that the bot will access. +2. Clone the repository and change into project directory. +``` +$ git clone https://github.com/SowinskiBraeden/police-cad-bot.git && cd police-cad-bot +``` 3. Run `npm install` to install dependencies. -4. Edit the `index.js` file to have the your correct parameters to run the bot. -The parameters are as follows: - 1. Version - 2. Bot Token - 3. path to config - 4. mongoURI - 5. mongoDBO -1. Run `npm start` to run the `index.js` file and start the bot. -1. The bot is now ready to use. - -### Setting up MongoDB -1. Install mongodb via brew [Step by step instructions](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-os-x/) -1. Start mongodb via brew [Step by step instructions](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-os-x/#run-mongodb-community-edition) - -### Accessing the Database -1. Locally this will use the knoldus db (or whatever you specify manually) -1. launch mongo via your command-line: `mongo` -1. Use `show dbs` to see all that are available. You should see `knoldus` in the list. -1. Lets use that db: `use knoldus`. +4. Duplicate `.env.example` and rename to `.env`. Edit to your configurations +5. Run the bot using node. +``` +$ node index.js +```