csu-xiao-an / bravo-be Goto Github PK

This project forked from bravolabs/bravo-be

Healthy office cultures often acknowledge good work from their coworkers and peers. Award your peers with acknowledgements that act like coins/points in Slack when they do awesome things - and never let the acknowledgement of their good work get lost in the shuffle again.

License: MIT License

JavaScript 99.11% HTML 0.89%

bravo-be's Introduction

Bravo Backend

Bot Commands

Type /bravo @user to choose between sending and viewing all acknowledgements

Project Files Structure

🚀 data directory

migrations directory
models directory
seeds directory
dbConfig.js file

🚀 routes directory

shoutouts.js

🚀 services directory

bot
shoutouts.js
shoutouts.spec.js

Coding styles and conventions

✔️ Folders, files and variables naming

Camel Case eg: bot, slackBot

✔️ Constants and env variables naming

Snake Case (All Caps) eg: SECRET, DATABASE_URL

✔️ Asynchronous Operations method

async await method

NPM Commands and Descriptions

Command	Description
`npm run server`	Starts the server in hot-reload mode for development
`npm test`	Runs the project test suite
`npm start`	Starts the app server in dev, staging and production environments

Prettier Setup for VS Code

Install the VS-Code extension below;
- Name: Prettier - Code formatter
- Id: esbenp.prettier-vscode
- Description: VS Code plugin for prettier/prettier
- Version: 1.9.0
- Publisher: Esben Petersen
- VS Marketplace Link: https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode
Head over to the VS-Code settings and search for prettier
Locate and tick the checkbox under Prettier: Eslint Integration section... You good to go! 😎