likelionMJU Bot
π¬ βοΈ π€
Facebook Serverless Messenger Bot
likelionMJU Bot is a simple facebook messenger bot to introduce likelionMJU, using AWS services.
π§ What's inside?
A quick look at the top-level files and directories you'll see in a likelionMJU Bot project.
.
βββ .github
βββ node_modules
βββ src
βββ .all-contributorsrc
βββ .eslintrc.js
βββ .gitignore
βββ .prettierignore
βββ .prettierrc
βββ LICENSE
βββ README.md
βββ SECURITY.md
βββ jest.config.js
βββ index.js
βββ package-lock.json
βββ package.json
-
/.github
: This directory contains a set-up of GitHub Actions, a template for the issue / pull-request, and a guide to conducts and contributions. -
/node_modules
: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed. -
/src
: This directory contains the functions that handler needs. For example, functions for processing GET / POST requests are included. -
.all-contributorsrc
: This is a configuration file for All Contributors. All Contributors is a specification for recognizing contributors to an open source project in a way that rewards each and every contribution, not just code. -
.eslintrc.js
: This is a configuration file for ESLint. ESLint is a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code, with the goal of making code more consistent and avoiding bugs. -
.gitignore
: This file tells git which files it should not track / not maintain a version history for. -
.prettierignore
: This file tells Prettier which files it should not format for. -
.prettierrc
: This is a configuration file for Prettier. Prettier is a tool to help keep the formatting of your code consistent. -
LICENSE
: likelionMJU Bot is licensed under the MIT license. -
README.md
: A text file containing useful reference information about your project. -
SECURITY.md
: This file defines how users should report security vulnerabilities for this repository. -
jest.config.js
: This is a configuration file for Jest. Jest is a JavaScript testing framework. -
package-lock.json
(Seepackage.json
below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (You wonβt change this file directly). -
package.json
: A manifest file for Node.js projects, which includes things like metadata (the projectβs name, author, etc). This manifest is how npm knows which packages to install for your project.
β
Testing
Creating New Tests
Check out the Jest documentation for how to write more tests.
Running Tests
To run Jest tests on the project, run npm test
on the command line.
β Code of Conduct
We expect everyone participating in the contributing to abide by Code of Conduct.
π Bug reporting
If you found a bug in this repository, please let us know through the Issue.
π€ How to Contribute
Check out Contributing guide for ideas on contributing and setup steps for getting our repositories up and running on your local machine.
β¨ Contributors
Thanks goes to these wonderful people (emoji key):
Jongwoo Han |
λͺ μ§λνκ΅(μμΈ) x Likelion |
allcontributors[bot] |
This project follows the all-contributors specification. Contributions of any kind welcome!
π License
Licensed under the MIT License.