Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/m-nathani/bgt-attendance
Burhani Guards Trust Div 2 attendance system
https://github.com/m-nathani/bgt-attendance
koa node sequlize
Last synced: 24 days ago
JSON representation
Burhani Guards Trust Div 2 attendance system
- Host: GitHub
- URL: https://github.com/m-nathani/bgt-attendance
- Owner: m-nathani
- Created: 2018-05-23T08:32:13.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-05-29T08:11:43.000Z (over 6 years ago)
- Last Synced: 2024-11-12T17:50:05.530Z (3 months ago)
- Topics: koa, node, sequlize
- Language: JavaScript
- Size: 97.7 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## `BGT DIV 2 Attendance System`
> Burhani Guards Trust Division 2 attendance system.
### Setup
```bash
# clone the repository
λ git clone https://github.com/m-nathani/bgt-attendance.git
# change the current directory
λ cd bgt-attendance
# install all dependencies
λ npm install
# run the project
λ npm start
```
### Structure
```bash
├── README.md # you're here
├── bin # folder that bootstraps the application
├── src # contains source files
│ ├── conf # wraps configurations files
│ ├── controller # contains all controllers in the application
│ ├── middleware # folder with all middlewares
│ ├── route # wraps all the routes and exports a single composed middleware
│ └── service # contains all the service logic
└── test # unit tests
```
**Suggestion:** Every folder name is _singular_ like `route`, `middleware` instead of `routes`, `middlewares`. If you want to add more folders as per your need, make sure they should be singular too (for e.g. `util`, `helper` etc) only for the sake of consistency.
### Included
- [Koa](https://github.com/koajs/koa) Well, duh.
- [Koa Router](https://github.com/alexmingoia/koa-router) For routing and all.
- [Debug](https://github.com/visionmedia/debug) Debug messages in the development environment.
- [Bunyan](https://github.com/trentm/node-bunyan) Extensive logging module.
- [Ava](https://github.com/avajs/ava) For unit tests.
- [Boom](https://github.com/hapijs/boom) HTTP Errors.
- [Convict](https://github.com/mozilla/node-convict) Configuration management.
- [Babel](https://github.com/babel/babel) Support ES6/ES7 features.
- [ESLint](https://github.com/eslint/eslint/) Linting purposes (comes with extended Airbnb's base eslint configurations).
- [Nodemon](https://github.com/remy/nodemon) Restart the server automatically (hot-reloading).
And many more small packages.
### Scripts
- `npm start` - simply starts the server
- `npm test` - execute all unit tests
- `npm run lint` - lints all the files in `src/` folder
- `npm run lint:fix` - fixes all the possible linting errors
- `npm run watch` - starts the server with hot-reloading
**Suggestion:** To turn on debug messages, set `DEBUG` environment variable to `bgt-div:*`