Rename project to swaf

This commit is contained in:
Alice Gaudon 2020-11-12 16:26:47 +01:00
parent f15535dda9
commit c3031d8171
5 changed files with 41 additions and 9 deletions

View File

@ -1 +1,33 @@
# WMS-Core # Structure Web Application Framework
A NodeJS TypeScript web application framework (duh).
## /!\ Still in development! There are not near enough tests /!\
Use at your own risk. Also please feel free to contribute with issues, bug reports and pull requests.
## Features
### Application building
- Model, View, Controller
- Uses express
- Custom Middleware classes that enable advanced modularity
- Modular models (you can add components with some definition automation)
- Simple database migrations (raw sql queries for now)
- Nunjucks for the view template engine
- Mail template system using Nunjucks + MJML
- Beautiful logging thanks to `tslog`
### Databases
- MySQL (persistent data)
- Redis (cache, session)
- (more to come)
### Common systems
- Advanced modular multi-factor authentication system
- CSRF protection
- WebSocket server with Controller-style endpoint listeners
- WIP: automatic updates

View File

@ -18,13 +18,13 @@
host: "localhost", host: "localhost",
user: "root", user: "root",
password: "", password: "",
database: "wms2", database: "swaf",
create_database_automatically: false create_database_automatically: false
}, },
redis: { redis: {
host: "127.0.0.1", host: "127.0.0.1",
port: 6379, port: 6379,
prefix: 'wms' prefix: 'swaf'
}, },
session: { session: {
secret: 'default', secret: 'default',

View File

@ -3,7 +3,7 @@
host: "localhost", host: "localhost",
user: "root", user: "root",
password: "", password: "",
database: "wms2_core_test", database: "swaf_test",
create_database_automatically: true create_database_automatically: true
} }
} }

View File

@ -1,8 +1,8 @@
{ {
"name": "wms-core", "name": "swaf",
"version": "0.22.5", "version": "0.22.5",
"description": "Node web application framework and toolbelt.", "description": "Structure Web Application Framework.",
"repository": "https://gitlab.com/ArisuOngaku/wms-core", "repository": "https://eternae.ink/arisu/swaf",
"author": "Alice Gaudon <alice@gaudon.pro>", "author": "Alice Gaudon <alice@gaudon.pro>",
"license": "MIT", "license": "MIT",
"readme": "README.md", "readme": "README.md",

View File

@ -2,7 +2,7 @@
{% import 'macros.njk' as macros %} {% import 'macros.njk' as macros %}
{% set actionType = magicLink.action_type %} {% set actionType = magicLink.action_type %}
{% set title = 'WMS: Magic Link' + (' - ' + actionType if actionType) %} {% set title = app.name + 'Magic Link' + (' - ' + actionType if actionType) %}
{% set h1 = 'Magic Link' + (' - ' + actionType if actionType) %} {% set h1 = 'Magic Link' + (' - ' + actionType if actionType) %}
{% block body %} {% block body %}
@ -16,4 +16,4 @@
{% endif %} {% endif %}
</div> </div>
</div> </div>
{% endblock %} {% endblock %}