better documentation

This commit is contained in:
lesion
2019-08-06 01:12:05 +02:00
parent 60edcbb970
commit 689b4d0a76
29 changed files with 261 additions and 823 deletions

View File

@@ -11,10 +11,10 @@ has_children: true
**Gancio** is built with following technologies:
- [Nuxt.js](https://nuxtjs.org/)
- Vue.js
- [Vue.js](https://vuejs.org/)
- Express
- Node.js
- Sequelize
- [Sequelize](https://sequelize.org/)
- Element.ui
### Testing on your own machine

View File

@@ -5,25 +5,28 @@ permalink: /dev/structure
parent: Hacking
---
### Structure
### Project structure
{: .no_toc }
1. TOC
{:toc}
### API / backend
Source code inside `server/api/`.
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.
[Express.js](https://expressjs.com/) 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
[Node.js](https://en.wikipedia.org/wiki/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`.
[Sequelize](https://sequelize.org/) is used as ORM. Take a look in [`/server/api/models`](https://git.lattuga.net/cisti/gancio/src/master/server/api/models).
### Client / frontend
@@ -33,4 +36,5 @@ Client routing in nuxt is automatic (if you don't need something special),
just put your page inside `pages` and that's it!
### Federation / ActivityPub
Code inside [`server/federation`](https://git.lattuga.net/cisti/gancio/src/master/server/federation).