Skip to content

Latest commit

 

History

History
139 lines (95 loc) · 7.18 KB

README.md

File metadata and controls

139 lines (95 loc) · 7.18 KB
Raw

logo

likelionMJU Bot

📬⚙️🤖

Facebook Serverless Messenger Bot

likelionMJU Bot is a simple facebook messenger bot to introduce likelionMJU, using AWS services.

LICENSE CodeFactor CodeQL Status Deploy to Lambda Status

mockup

🧐 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

  1. /.github: This directory contains a set-up of GitHub Actions, a template for the issue / pull-request, and a guide to conducts and contributions.

  2. /node_modules: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.

  3. /src: This directory contains the functions that handler needs. For example, functions for processing GET / POST requests are included.

  4. .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.

  5. .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.

  6. .gitignore: This file tells git which files it should not track / not maintain a version history for.

  7. .prettierignore: This file tells Prettier which files it should not format for.

  8. .prettierrc: This is a configuration file for Prettier. Prettier is a tool to help keep the formatting of your code consistent.

  9. LICENSE: likelionMJU Bot is licensed under the MIT license.

  10. README.md: A text file containing useful reference information about your project.

  11. SECURITY.md: This file defines how users should report security vulnerabilities for this repository.

  12. jest.config.js: This is a configuration file for Jest. Jest is a JavaScript testing framework.

  13. package-lock.json (See package.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).

  14. 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.