https://github.com/amovah/bird
Framework for web ( it's my personal template :D), I dont use this anymore
https://github.com/amovah/bird
framework web
Last synced: 7 months ago
JSON representation
Framework for web ( it's my personal template :D), I dont use this anymore
- Host: GitHub
- URL: https://github.com/amovah/bird
- Owner: amovah
- License: mit
- Created: 2017-04-22T18:54:16.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-01-18T21:41:03.000Z (about 8 years ago)
- Last Synced: 2025-02-24T06:36:04.279Z (about 1 year ago)
- Topics: framework, web
- Language: JavaScript
- Homepage:
- Size: 119 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# bird
framework for web (it's my personal template for starting a new web project :D )
Clone the project using `git clone https://github.com/amovah/bird.git` command.
Then install the dependencies using `yarn install` command, and:
```[sudo] npm install -g gulp nodemon```
Remember, you must have MongoDB installed on your machine.
And to run the project, run `gulp full:dev && npm run devserver` command.
[Contributing](https://github.com/amovah/bird/blob/master/CONTRIBUTING.md)
If you want to make any changes or build the project, you have three ways:
1. `npm run client:build` that just watches `/src/views` and `/src/public/`
2. `npm run server:build` that watches other directories than `src/views` and `/src/public/`
3. `npm run full:build` that watches all of the directories in `src/` dir.
### Router
To add routers, you should create a file in `src/routers/` directory, the simplest way is to write `./bird router ROUTERNAME` in command line.
### Model(Database Collections)
To add collecions, you should create a file in `src/models` directory, the simplest way is to write `./bird model MODELNAME` in command line.
### Public Files
To add CSS, JavaScript, Fonts or Images you should put them in `src/public` file.
Note: CSS files must have .less extension in `/src/public/css/`, except `/src/public/css/lib/` that must have .css
### Utilities
To add utilities you should add files to `src/utils/`
### View
To add html files you should add them to `/src/views/`
Note: In this project we're using nunjucks template, so your files must have .njk extension
### Permissions
To add a permission, add the file to `src/perms/`
## Before you push
Make sure that your files are lint.
You can lint js files in `src/public/js` files using `gulp client:lint` command.
And Other JS files using `gulp server:lint` command.