Skip to content

Commit

Permalink
Merge branch 'release/4.0.0-alpha.1'
Browse files Browse the repository at this point in the history
  • Loading branch information
brunobuddy committed May 27, 2024
2 parents d4393b5 + ad7b563 commit ffce948
Show file tree
Hide file tree
Showing 30 changed files with 4,506 additions and 228 deletions.
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,14 @@
<a href="https://opencollective.com/casejs" target="_blank">
<img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us">
</a>
<a href=https://github.com/ManifestOfficial/manifest/blob/develop/LICENSE" target="_blank">
<img alt="Licence MIT" src="https://img.shields.io/badge/licence-MIT-green">
<a href="https://github.com/ManifestOfficial/manifest/blob/develop/LICENSE" target="_blank">
<img alt="License MIT" src="https://img.shields.io/badge/licence-MIT-green">
</a>
<br>
</p>

# Manifest

[Manifest](https://manifest.build) is the simplest **BaaS (Backend As A Service)** you will find.

It provides a complete backend to your client app without the hassle that comes with it. It actually fits into **a single YAML file** that generates a complete backend.

Here is an example of a complete Manifest app:

```yaml
Expand Down
25 changes: 25 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Examples

This folders hosts examples of Manifest implementations for **contributors**.

## How to work with npm link

[NPM Link](https://docs.npmjs.com/cli/v10/commands/npm-link) is a great tool to develop packages on real-world situations without having to publish them.

### Example with NPM manifest package

First go to `packages/core/manifest` and run this command to link the "manifest" package.

```
sudo npm link
```

the go to a folder that as `manifest` as a dependency in its `package.json` and run

```
npm link manifest
```

The local "manifest" package will now replace the dependency.

Attention: for some reason the `nodemon` binary gets removed this way. Try to add it if the `npm run manifest` command is not working: `npm i nodemon`
3 changes: 3 additions & 0 deletions examples/standalone/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@

node_modules
.env
5 changes: 5 additions & 0 deletions examples/standalone/.vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"recommendations": [
"redhat.vscode-yaml"
]
}
5 changes: 5 additions & 0 deletions examples/standalone/.vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"yaml.schemas": {
"https://schema.manifest.build/schema.json": "**/manifest/**/*.yml"
}
}
Binary file added examples/standalone/manifest/backend.db
Binary file not shown.
14 changes: 14 additions & 0 deletions examples/standalone/manifest/backend.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: My pet app
entities:
😃 Owner:
properties:
- name
- { name: email, type: email }

😺 Cat:
properties:
- name
- { name: age, type: number }
- { name: birthdate, type: date }
belongsTo:
- Owner
Loading

0 comments on commit ffce948

Please sign in to comment.