belfy - GitLite

KO | EN

gitlite — search

#javascript #python #react #deep-learning #linux #nodejs #java #windows #cli #kubernetes #vue #security #mcp #openai

belfy

(★ 94)

Create a CRUD application from simple data definition yaml files and customise it using yaml.

File Explorer

Download Latest Version (.zip)

- settings.json
- entities.yaml
- navbar.yaml
- page_overrides.yaml
- - cli.ts
  - config-loader.ts
  - file-utils.ts
- - generators.ts
- - index.ts
- - file.test.ts
  - file.ts
.eslintrc.cjs
.gitignore
.prettierrc
jest.config.js
LICENSE
package-lock.json
package.json
README.md
tsconfig.json
tsconfig.tsbuildinfo

# Installation Guide

1. Get the code

git clone https://github.com/utopiops/belfy

Downloads the entire project code from GitHub to your computer.

cd belfy

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.

docker compose -f src/generator/generators/node-express/scaffold/docker-compose.yaml up -d --build

Runs the command against the services defined in the compose file.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install @utopiops/belfy

Downloads and installs the libraries listed in package.json.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<img width="10%" alt="belfy" src="https://github.com/utopiops/belfy/assets/15846333/1686367e-2000-4dcc-a4f5-14b6351a29d3"/>

# Belfy

[Belfy](https://belfy.io) is a tool for generating CRUD web applications based on provided data definitions. It simplifies the process of creating full-stack or split-stack applications by automatically generating the necessary code based on the user's input.

## Features

- **Automatic Code Generation:** Belfy generates code for CRUD operations based on the provided data definitions.
- **Modular Architecture:** Easily extend Belfy with additional frameworks, languages, and features through modular plugins.
- **Multiple Framework Support:** Currently supports Node.js (Express) full-stack, with plans to add support for more frameworks in the future.
- **Customization:** Customize the generated code by providing specific options and configurations.

# Status

## Currently supported

### Full-stack

<img width="10%" alt="node" src="https://user-images.githubusercontent.com/15846333/166142689-ddcd042c-418a-4336-ab27-76c156f3bb67.png" />

### Front-end
<img width="10%" src="https://user-images.githubusercontent.com/15846333/166142296-8e1c68de-601b-46de-8a9f-dd0c451129b9.png" />

### Back-end
<img width="10%" alt="node" src="https://user-images.githubusercontent.com/15846333/166142689-ddcd042c-418a-4336-ab27-76c156f3bb67.png" />

## Future releases

<img width="10%" alt="go" src="https://user-images.githubusercontent.com/15846333/166142724-c6bd4b2a-8204-4283-a521-33703ca8977a.png" /> 
<img width="10%" src="https://user-images.githubusercontent.com/15846333/166142313-828d6a84-2d76-41d5-abe7-b0595d022eac.png" /> <img width="10%" alt="Angular" src="https://user-images.githubusercontent.com/15846333/166142526-ea89df14-3af9-4e43-b9de-d391efc5df51.png" /> <img width="10%" alt="svelte" src="https://user-images.githubusercontent.com/15846333/166142628-efdca347-9ec4-42db-82a1-2ac9bd9c1ad0.png"/> 
<img width="10%" alt="node" src="https://user-images.githubusercontent.com/15846333/166142689-ddcd042c-418a-4336-ab27-76c156f3bb67.png" />
<img width="10%" alt="Next" src="https://user-images.githubusercontent.com/15846333/166142563-6bc6b8c9-c914-4685-8ca4-7b8cc3509f8f.png" /> <img width="10%" alt="Nuxt" src="https://user-images.githubusercontent.com/15846333/166142496-abdc74e9-2985-4c89-872f-d35e77bb64cc.png" />
<img width="10%" src="https://user-images.githubusercontent.com/15846333/166142706-b82590f6-b73a-4eb3-96c3-956c38ca3c8d.png" /> <img width="10%" alt="php" src="https://user-images.githubusercontent.com/15846333/166142808-7cee080b-f870-4806-b5ed-665045c9c030.png" /> <img width="10%" alt="c#" src="https://user-images.githubusercontent.com/15846333/166142851-05492ac9-122c-46cd-bf96-560f49319df5.png" /> <img width="10%" alt="rust" src="https://user-images.githubusercontent.com/15846333/166142779-8f7389c2-56ce-4f8a-97c7-3420e7a6b189.png" />

# Installation

Development environment:
`npm install`
`npm start`

Coming soon:

To run the CLI using the `npm` package:

```
npm install @utopiops/belfy
belfy generate
```

# Documentation
See [belfy.io](https://belfy.io).
## Configuration
Belfy uses YAML files to define data models, navigation bars, and page overrides.

entities.yaml: Defines the data models.
navbar.yaml: Specifies the items to be displayed in the navigation bar.
page_overrides.yaml: Allows customization of page behavior.

# Contributing
Contributions are welcome! Please read the Contribution Guidelines (coming soon) before submitting any pull requests.

# License

This project is licensed under the Apache-2.0 License - see the LICENSE file for details.

# Belfy Mascot

Isn't Belfy adorable? Meet our mascot, the cute and cuddly Belfy creature!
<img width="20%" alt="belfy" src="https://github.com/utopiops/belfy/assets/15846333/5c94a815-8fc4-4bc8-9d89-cc37b588d351" />