Skip to content

Commit

Permalink
Merge branch 'release/4.0.0-beta'
Browse files Browse the repository at this point in the history
  • Loading branch information
brunobuddy committed Sep 2, 2024
2 parents 85b4006 + ff3e1bb commit 6fc9b74
Show file tree
Hide file tree
Showing 101 changed files with 2,526 additions and 681 deletions.
1 change: 1 addition & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Check the packages that require a new publication or release:
- [ ] @mnfst/manifest
- [ ] @mnfst/types
- [ ] @mnfst/admin
- [ ] @mnfst/js-sdk
- [ ] doc

## Check list before submitting
Expand Down
4 changes: 3 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
"cSpell.words": [
"authenticable",
"bugsnag",
"bulma",
"dasherize",
"dasherized",
"dtos",
Expand All @@ -35,11 +36,12 @@
"mnfst",
"nestjs",
"openapi",
"shortcodes",
"signup",
"typeorm",
"uniqid"
],
"material-icon-theme.files.associations": {
"**.controller.ts": "nest",
"**routing.module.ts": "routes"
},
"material-icon-theme.folders.associations": {
Expand Down
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,9 @@
<br>
</p>

> [!NOTE]
> Manifest is in the Proof of Concept phase (PoC). We are currently developing the first stable version. We would love to have your feedback ! If something do not work as expected, please [open a Github issue](https://github.com/mnfst/manifest/issues/new/choose). For any other thing, let us know trough [The Manifest Discord channel](https://discord.com/invite/FepAked3W7).
[Manifest](https://manifest.build) is the simplest **BaaS (Backend As A Service)** you will find.
[Manifest](https://manifest.build) is a complete backend that fits in a single YAML file:

Here is an example of a complete Manifest app:
<a href="https://stackblitz.com/fork/github/mnfst/manifest/tree/master/examples/main-demo?file=manifest/backend.yml" target="_blank"><img alt="Open in StackBlitz" src="https://developer.stackblitz.com/img/open_in_stackblitz.svg"></a>

```yaml
# manifest/backend.yml
Expand All @@ -51,11 +48,14 @@ entities:
- name
```
> [!NOTE]
> Manifest is on BETA. We would love to have your feedback ! If something do not work as expected, please [open a Github issue](https://github.com/mnfst/manifest/issues/new/choose). For any other thing, let us know trough [The Manifest Discord channel](https://discord.com/invite/FepAked3W7).
## Key features
- ⚡ **Instant complete backend** with zero configuration
- 🧠 **Super-easy syntax** to build with ease
- 🛠️ **Plug and play** with your favorite frontend
- ⚡ **Develop 10x faster** comparing to traditional approaches
- 😎 **Super-easy syntax** easy to read and version control
- 🕊️ **Self-hosted** free open source software
## Getting started
Expand All @@ -66,20 +66,20 @@ npx add-manifest
```

## Product roadmap

Our mission is to enable developers of all experience levels to create and share innovative solutions. As an **open source** product, we continuously improve Manifest through community collaboration. After our successful PoC, we are further developing the product with your feedback. Here are the upcoming features:

| Feature | Description | Release date | Status |
| --- | --- | --- | --- |
| **OpenAPI Doc** | Instant live documentation for your REST API | July 2024 | ✅ Available |
| **Auth** | Make any entity authenticatable and add rules for endpoints | August 2024 | 🚧 In progress |
| **Validation** | Custom validation for creating and updating items | Q3 2024 | 📝 To specify |
| **Many-to-many** | Advanced relationship management | Q4 2024 | 📝 To specify |
| **Hooks** | Trigger webhooks at specific events | Q4 2024 | 📝 To specify |
| **Media upload** | Allow file and image uploads with rules and resizing | Q4 2024 | 📝 To specify |
| Feature | Description | Release date | Status |
| ---------------- | ----------------------------------------------------------- | ------------ | -------------- |
| **OpenAPI Doc** | Instant live documentation for your REST API | July 2024 | ✅ Available |
| **Auth** | Make any entity authenticatable and add rules for endpoints | August 2024 | ✅ Available |
| **Validation** | Custom validation for creating and updating items | Q4 2024 | 🚧 In progress |
| **Many-to-many** | Advanced relationship management | Q4 2024 | 📝 To specify |
| **Hooks** | Trigger webhooks at specific events | Q4 2024 | 📝 To specify |
| **Media upload** | Allow file and image uploads with rules and resizing | Q4 2024 | 📝 To specify |

🆕 [Suggest a new feature for the next versions](https://github.com/mnfst/manifest/discussions/new?category=feature-request)


## Community & Resources

- [Docs](https://manifest.build/docs) - Get started with Manifest
Expand Down
1 change: 1 addition & 0 deletions examples/main-demo/.env
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
TOKEN_SECRET_KEY=ReplaceMeWithYourSecretKey
2 changes: 2 additions & 0 deletions examples/main-demo/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@

node_modules
3 changes: 3 additions & 0 deletions examples/main-demo/.stackblitzrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"startCommand": "npm run manifest"
}
File renamed without changes.
File renamed without changes.
33 changes: 33 additions & 0 deletions examples/main-demo/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# 🦚 Manifest Demo

This is a [Manifest](https://manifest.build) demo project.

## Available scripts

In the project directory, you can run:

```
npm i
npm run manifest
```

Runs the app in the development mode.\
Open [http://localhost:1111](http://localhost:1111) to view the admin panel in your browser.\
Open [http://localhost:1111/api](http://localhost:1111/api) to view the REST API documentation in your browser.\

The page will reload when you make changes.

````
npm manifest:seed
```
Seeds dummy data for your entities and properties. This commands deletes the previous data.
## Access to the admin panel
**EMAIL:** [email protected]
**PASSWORD:** admin
## Learn More
You can learn more in the [Manifest documentation](https://manifest.build/docs).
Binary file added examples/main-demo/manifest/backend.db
Binary file not shown.
50 changes: 50 additions & 0 deletions examples/main-demo/manifest/backend.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# 🦚 WELCOME TO MANIFEST 🦚 - A complete backend in 1 single file
# Read more at https://manifest.build/docs

# ******************************************
# * ADMIN PANEL CREDENTIALS *
# * *
# * EMAIL: [email protected] *
# * PASSWORD: admin *
# ******************************************

name: Simple Invoicing App

entities: # Define your entities here.
📄 Invoice:
properties:
- { name: date, type: date }
- { name: invoiceNumber, type: number }
- { name: amount, type: money, options: { currency: USD } }
- { name: payed, type: boolean }
belongsTo:
- Project # A simple relationship between Invoice and Project

🛠️ Project:
properties:
- name
- description
- { name: deadline, type: date }
- { name: budget, type: money, options: { currency: USD } }
- {
name: type,
type: choice,
options: { values: ['Service', 'Product', 'Retail'] }
}
- { name: finished, type: boolean }
# Checkout all available real-world types: https://manifest.build/docs/properties#property-types
belongsTo:
- Customer

🧾 Customer:
properties:
- { name: name, type: string }
- { name: email, type: email }
- { name: billingAddress, type: text }
- { name: location, type: location }
- {
name: industry,
type: choice,
options:
{ values: ['Retail', 'Services', 'Manufacturing', 'Technology'] }
}
Loading

0 comments on commit 6fc9b74

Please sign in to comment.