Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/victor-abz/frappejs-backend

Frappe backend is a meta-data driven backend framework that enables rapid application development of Node.js REST API. Inspired by [frappejs](https://github.com/frappe/frappejs) a product from [Frappe](https://frappeframework.com).
https://github.com/victor-abz/frappejs-backend

framework json-schema metadata node rapid-development

Last synced: 1 day ago
JSON representation

Host: GitHub
URL: https://github.com/victor-abz/frappejs-backend
Owner: victor-abz
Created: 2022-03-14T22:03:56.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2022-07-24T13:28:02.000Z (over 2 years ago)
Last Synced: 2025-01-21T21:03:36.590Z (12 days ago)
Topics: framework, json-schema, metadata, node, rapid-development
Language: JavaScript
Homepage:
Size: 934 KB
Stars: 0
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Frappe-backend.js

Frappe backend is a meta-data driven backend framework that enables rapid application development of Node.js REST API.
Inspired by [frappejs](https://github.com/frappe/frappejs) a product from [Frappe](https://frappeframework.com).

The objective of Frappe Backend is be a clean and opinionated micro-framework to develop small-business applications.

So, I love the simplicity of frappejs, and the Schema defined in the frappe framework to act as a Document Oriented framework, but using the power of a Relational Database Engine, what simplify and boost the level of coherence in the system.

## Features

- Rapid REST-API Development
- Database backends

## Quick Start

---

> You can quickly get started with [Typescript BoilerPlate](https://github.com/victor-abz/frappe-backend-typescript-boilerplate)

---

I you like to build it on your own, follow below guide:

### Initialize a new NodeJS project

`mkdir fback-demo && cd fback-demo`
`npm init -y`

### Install Frappe Backend

`npm i frappe-backend`

add the Following to your package.json
To start the server add this to your `package.json`

```bash
{
...
"scripts": {
"new-model": "frp-cmd new-model",
"start": "frp-cmd start",
"dev": "frp-cmd start dev"
}
...
}
```

### Create app Entry file for your project. e.g app.js and backend config file

```js
const server = require('frappe-backend/server');

server.start({
backend: 'pg', // To start a postgres backend.
connectionParams: {
db_name: process.env.DB_NAME, // Existing postgres database name
username: process.env.DB_USERNAME, // Database username
password: process.env.DB_PWD, // Database password
host: process.env.DB_HOST, // Database host
client: 'pg', // Database client. options are [pg]
},
enableCORS: true,
// models, // this will contain your database models
// routes,
// middlewareList: [testMid(124), testMid(5)],
});
```

Create `frappe-backend.conf.js` file at the root directory of your project. Minimum config look like:

```js
module.exports = {
dev: {
devServerPort: process.env.PORT || 3000,
devServerHost: 'localhost',
},
baseDir: '.', // If you want the model codes to be in another folder such as src
useEs6: true, // If you want to generate models in ES6 Format
node: {
paths: {
main: 'app.js',
},
},
nodemon: {
// To be able to run the development server
watch: ['.'],
ext: '.ts,.js',
ignore: [],
exec: 'ts-node',
entry: './src/app.ts',
},
};
```

### To Generate your first Model(model is like database table). Example ToDo:

Now run `npm run new_model ToDo`
This will create a new model in `models/doctype` called ToDo
it will include a name field which represent the ID of each record. Go ahead and add the following fields under fields.:
[Read this to Understand more about models](docs/models/index.md)

```js
{
fieldname: 'subject',
label: t`Subject`,
placeholder: 'Subject',
fieldtype: 'Data',
required: 1,
},
{
fieldname: 'status',
label: t`Status`,
fieldtype: 'Select',
options: ['Open', 'Closed'],
default: 'Open',
required: 1,
},
{
fieldname: 'description',
label: t`Description`,
fieldtype: 'Text',
},
```

Your ToDo.js Model should like this now:

```js
module.exports = {
name: 'ToDo',
label: 'ToDo',
naming: 'name', // {random|autoincrement}
isSingle: 0,
isChild: 0,
isSubmittable: 0,
settings: null,
keywordFields: [],
fields: [
{
fieldname: 'name',
label: 'Name',
fieldtype: 'Data',
required: 1,
},
{
fieldname: 'subject',
label: t`Subject`,
placeholder: 'Subject',
fieldtype: 'Data',
required: 1,
},
{
fieldname: 'status',
label: t`Status`,
fieldtype: 'Select',
options: ['Open', 'Closed'],
default: 'Open',
required: 1,
},
{
fieldname: 'description',
label: t`Description`,
fieldtype: 'Text',
},
],
};
```

Import models folder in your entry file

```js
const server = require('frappe-backend/server');
const models = require('./models'); // Import Models folder
// import routes from './routes'; // Import Custom Routes
// import { testMid } from './middleware/sample.middleware';

server.start({
backend: 'pg', // To start a postgres backend.
connectionParams: {
db_name: process.env.DB_NAME, // Existing postgres database name
username: process.env.DB_USERNAME, // Database username
password: process.env.DB_PWD, // Database password
host: process.env.DB_HOST, // Database host
client: 'pg', // Database client. options are [pg]
},
enableCORS: true,
models, // Your Import
// routes, // Your custom routing
// middlewareList: [middleWare1, middleWare2], // Pass global middleware functions
});
```

### Start Server

now run your server with `npm run start`. Your NodeJs Server will start at specified port.
Go to your Postman and you should be able to consume RestAPI to your ToDo model.
[check this RestAPI Documentation](docs/server/rest.md)

## Documentation

[Read the full docs](docs/index.md)

## ToDo

- [x] Allow custom Routes and overriding
- [x] Add development nodemon reload/watch changes to files
- [x] Pass custom Middleware to routes
- [ ] Integrate various type of Authentication
- [ ] Convert Package to Typescript

## Contribution

You are welcome to contibute. Just raise the PR.

## License

MIT