external-repos/noisedash
1
0
Fork 1
mirror of https://github.com/kaythomas0/noisedash.git synced 2025-11-11 19:06:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Kevin Thomas
2022-05-08 17:05:22 -07:00
parent fa59f8ebfe
commit 8e1a8aeb05
1 changed files with 19 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
CONTRIBUTING.md
View File

@@ -1,4 +1,6 @@
## Project setup
Requires [Node](https://nodejs.org/en/download/) and [Vue 2 CLI](https://cli.vuejs.org/guide/installation.html)
```
npm install
```
@@ -23,5 +25,22 @@ npm run build
npm run lint
```
### Directory Summary
Here are some of the more important files and directories:
* `config/default.json`: Contains the default configuration file
* `server/*`: Where all of the node server related code is
* `server/app.js`: The main server file where server settings are set
* `server/db.js`: Where the database is created
* `server/logger.js`: Where the logger is created and configured
* `server/bin/www.js`: The entry point of the server application (what you run to start the server)
* `server/boot/*`: These are run on server startup
* `server/routes/*`: Where all of the server routes and logic are defined
* `src/*`: Contains all the frontend code
* `src/components/*`: Where all of the Vue components are defined, split into vue and js files for each component
* `src/router/index.js`: Where all the routing and route-protection logic is defined
* `src/views/*`: Contains all the views
### Customize configuration
See [Configuration Reference](https://cli.vuejs.org/config/).