more on documentation
This commit is contained in:
36
docs/dev/structure.md
Normal file
36
docs/dev/structure.md
Normal file
@@ -0,0 +1,36 @@
|
||||
---
|
||||
layout: default
|
||||
title: Project Structure
|
||||
permalink: /dev/structure
|
||||
parent: Hacking
|
||||
---
|
||||
|
||||
### Structure
|
||||
|
||||
|
||||
### API / backend
|
||||
|
||||
Source code inside `server/api/`.
|
||||
`index.js` is basically a routing table pointing each PATH with specified
|
||||
HTTP VERB to a method of a controller.
|
||||
|
||||
jwt is used to authenticate api request.
|
||||
|
||||
Express is based on middleware, passing each request to a chain of methods.
|
||||
|
||||
If you come from a PHP background, note that the main difference with
|
||||
Node.js is that the server process is always running and able to manage
|
||||
multiple requests and tasks together (asyncronically) while each php
|
||||
process is tied to a single request.
|
||||
|
||||
Sequelize is used as ORM. Take a look in `/server/api/models`.
|
||||
|
||||
|
||||
### Client / frontend
|
||||
Nuxt.js is used here!
|
||||
Nuxt is basically Vue plus SSR (Server Side Rendering).
|
||||
Client routing in nuxt is automatic (if you don't need something special),
|
||||
just put your page inside `pages` and that's it!
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user