https://github.com/philippebeck/nens

Node/Express Framework with MySQL
https://github.com/philippebeck/nens

api express framework node sql

Last synced: 10 months ago
JSON representation

Node/Express Framework with MySQL

• Host: GitHub
• URL: https://github.com/philippebeck/nens
• Owner: philippebeck
• License: apache-2.0
• Created: 2023-11-23T06:43:30.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-23T08:59:32.000Z (over 1 year ago)
• Last Synced: 2024-08-23T10:07:28.962Z (over 1 year ago)
• Topics: api, express, framework, node, sql
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/nens
• Size: 491 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# Nens 

Backend Framework with Node, Express & SQL

[![NPM Version](https://badgen.net/npm/v/nens)](https://www.npmjs.com/package/nens)

[![NPM Downloads](https://badgen.net/npm/dt/nens)](https://www.npmjs.com/package/nens)

[![GitHub Last Commit](https://badgen.net/github/last-commit/philippebeck/nens)](https://github.com/philippebeck/nens/commits/master)

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/7e8b050c9e1a4350a1cbc93a1cbf85c0)](https://app.codacy.com/gh/philippebeck/nens/dashboard)

[![Maintainability](https://api.codeclimate.com/v1/badges/b7f0e56412a0b8c38be2/maintainability)](https://codeclimate.com/github/philippebeck/nens/maintainability)

[![GitHub Top Language](https://img.shields.io/github/languages/top/philippebeck/nens)](https://github.com/philippebeck/nens)

[![Code Size](https://img.shields.io/github/languages/code-size/philippebeck/nens)](https://github.com/philippebeck/nens/tree/master)

## Overview

Nens is a Backend Framework made with Node, Express & MySQL, where you can find an some packages complementary, like JWT, Nodemailer, Sharp & back securities  

## Summary

- [Nens](#nens)

  - [Overview](#overview)

  - [Summary](#summary)

  - [Download](#download)

  - [Package](#package)

  - [Installation](#installation)

  - [Configuration](#configuration)

  - [DataBase](#database)

  - [Usage](#usage)

  - [Content](#content)

  - [Documentation](#documentation)

---

## Download

[Use this Template](https://github.com/philippebeck/nens/generate)  

or  

`git clone https://github.com/philippebeck/nens.git`  

or  

[Latest Release](https://github.com/philippebeck/nens/releases)  

---

## Package

NPM : `npm i nens`  

or  

Yarn : `yarn add nens`  

**If you choose to get Nens from NPM or Yarn : you need to copy Nens from *node_modules/nens* to the root of your App**

---

## Installation

Install the backend dependencies :  

`$ cd nens`  

`$ npm i`  

---

## Configuration

Configure the .env.example by replacing the values *(like DB, Mailer & Token)* :  

`.env.example` *(then rename it .env)*  

Your personal .env will be hidden in .gitignore automatically  

---

## DataBase

Import the database tables :  

`$ mysql -u root -p < app/DBTables.sql` or with a UI like phpMyAdmin  

Personally, I have another SQL file for data insertion, hidden in .gitignore  

---

## Usage

To run the backend server :  

`$ npm start`  

---

## Content

Available API Files :

-  **AuthCtrl, AuthRoute** *(Auth)*  

-  **UserModel, UserCtrl, UserRoute** *(Users)*  

-  **ProductModel, ProductCtrl, ProductRoute** *(Products)*  

-  **OrderModel, OrderCtrl, OrderRoute** *(Product Orders)*  

-  **ArticleModel, ArticleCtrl, ArticleRoute** *(Articles)*  

-  **ProjectModel, ProjectCtrl, ProjectRoute** *(Projects)*  

-  **LinkModel, LinkCtrl, LinkRoute** *(Links)*  

-  **GalleryModel, GalleryCtrl, GalleryRoute** *(Galleries)*  

-  **ImageModel, ImageCtrl, ImageRoute** *(Gallery Images)*  

---

## Documentation

Available Documentation :  

-  [**API**](https://github.com/philippebeck/nens/blob/main/swagger.yaml)