https://github.com/dakdevs/zephyr-framework
An API/Admin Boilerplate Framework
https://github.com/dakdevs/zephyr-framework
Last synced: 8 months ago
JSON representation
An API/Admin Boilerplate Framework
- Host: GitHub
- URL: https://github.com/dakdevs/zephyr-framework
- Owner: dakdevs
- Created: 2019-07-03T04:39:47.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-04T01:37:28.000Z (over 3 years ago)
- Last Synced: 2025-03-01T10:27:15.593Z (over 1 year ago)
- Language: JavaScript
- Size: 284 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Zephyr API + Admin (Work In Progress)
## What is Zephyr?
Zephyr is an API/Admin Framework for developers to serve a RESTful and/or GraphQL Interface based on a straight-forward API. It brings together the latest technologies and their speed to give you this functionality.
Dependent on [Fastify](https://github.com/fastify/fastify) for API, [Pino](https://github.com/pinojs/pino) for logging, [Axios](https://github.com/axios/axios) for external calls, and [GatsbyJS](https://github.com/gatsbyjs/gatsby) for the admin panel.
## Installation
```bash
yarn add zephyr-framework
```
## Usage
**Option 1:** Just start it.
```js
import zephyr from 'zephyr-framework';
zephyr().then(() => {
console.log('Server has started.');
});
```
**Option 2:** Start the server and admin with custom fastify server and listen options.
For `serverOptions` and `listenOptions` see https://github.com/fastify/fastify/blob/master/docs/Server.md. They match Fastify's options schema.
```js
import { startAdmin } from 'zephyr-framework';
startAdmin({
serverOptions: {},
listenOptions: {},
}).then(startServer => startServer({
serverOptions: {},
listenOptions: {},
})).then(() => {
console.log('Server has started.');
});
```
## To be implemented
- https://www.apollographql.com/docs/graphql-tools/remote-schemas/#makeremoteexecutableschemaoptions