Skip to content

AugustineUmeagudosi/slack-bot

Repository files navigation

Slack-bot API

Apis for the slack-event-listener app

Requirements

For development, you will only need Node.js, npm, mongodb, and a node global package, Yarn, installed in your environment.

Node

  • Node installation on Windows

    Just go on official Node.js website and download the installer. Also, be sure to have git available in your PATH, npm might need it (You can find git here).

  • Node installation on Ubuntu

    You can install nodejs and npm easily with apt install, just run the following commands.

    Installation Commands
      $ sudo apt install nodejs
      $ sudo apt install npm
    
  • Other Operating Systems

    You can find more information about the installation on the official Node.js website and the official NPM website. If the installation was successful, you should be able to run the following command.

    verification Commands
      $ node --version
      v14.17.3 (recommended for this project)
      $ npm --version
      v7.20.5
    

    If you need to update npm, you can make it using npm! Cool right? After running the following command, just open again the command line and be happy.

    update Command
      $ npm install npm -g
    

Yarn

After installing node, this project will need yarn too, so just run the following command.

Installation Commands
$ npm install -g yarn

Project Installation

$ Clone the App
$ run `npm install` to install dependencies.

Configure app

Create a `.env` on the project's root directory, copy and fill in the values for the variables listed on the `.env.example` file

Running the project locally

$ run `npm run dev` to serve the app with hot reload at `localhost:4000` or `http://127.0.0.1:4000`

Running tests

$ npm test OR yarn run test

Technologies

  • Node JS
  • Express
  • Chai, Chai-http and mocha
  • Postman
  • MongoDB

Documentation

$ documentation can be found here `https://documenter.getpostman.com/view/10114803/UVsJv6ns`

Copyright

Copyright (c) 2022 Austin


About

A slack bot built with nodejs and express

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published