-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #17 from nsonanh/feature-readme-update
Feature readme update
- Loading branch information
Showing
2 changed files
with
19 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,37 +1,35 @@ | ||
# danhngon-api | ||
[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0) [![CircleCI](https://circleci.com/gh/nsonanh/danhngon-api/tree/master.svg?style=shield&circle-token=:circle-token)](https://circleci.com/gh/nsonanh/danhngon-api/tree/master) | ||
|
||
API Documentation | ||
- https://nsonanh.github.io/danhngon-api/public/apidoc/index.html | ||
## API Documentation | ||
### [danhngon-api documentation](https://nsonanh.github.io/danhngon-api/public/apidoc/index.html) | ||
|
||
Brain storm: | ||
## Brain storm: | ||
### Basic visual: | ||
![Danhngon brainstorm](./doc-img/danhngon.jpg?raw=true "Basic brainstorm of danhngon") | ||
|
||
Architecture: | ||
### Architecture: | ||
- REST single service (NodeJS, ExpressJS, MongoDB) | ||
- Backend app to manipulate data (pagination + filter must have) | ||
- JS lib to utilize with ajax (with end-user intro site) | ||
|
||
Specification: | ||
- One quote, many languages (profile & google translate ?) | ||
- JS lib to utilize with ajax (with end-user site) | ||
### Specification: | ||
- One quote, many languages (browser language & google translate) | ||
- Support latin & latin quotes | ||
- quote <-> author <-> category <-> original language | ||
|
||
Dev Ops | ||
- Cloud deployment (AWS ?) | ||
### Dev Ops | ||
- Cloud deployment | ||
- Structure : | ||
- danhngon-api <-> danhngon-admin | ||
- danhngon-api -> danhngon-js | ||
- danhngon-js -> Intro website | ||
|
||
DOC: | ||
- danhngon-js -> danhngon.global | ||
### DOC: | ||
- design diagrams | ||
- api | ||
- js | ||
|
||
Research: | ||
- apidoc | ||
- js doc | ||
### Research: | ||
- Elasticsearch | ||
- mongodb indexing | ||
- Restify framework | ||
- Test framework | ||
- CI tool | ||
- npm deployment | ||
- Data contribution | ||
- Avoid redundancy/duplication of quotes | ||
- Avoid redundancy/duplication of quotes |
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.