Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/asunder9/feathers-v5-template
Asunder - feathers v5 template
https://github.com/asunder9/feathers-v5-template
ajv feathersjs json-schema mongodb relationships v5
Last synced: 6 days ago
JSON representation
Asunder - feathers v5 template
- Host: GitHub
- URL: https://github.com/asunder9/feathers-v5-template
- Owner: asunder9
- Created: 2024-03-26T14:46:01.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-03-26T21:06:20.000Z (10 months ago)
- Last Synced: 2024-11-17T15:14:22.409Z (2 months ago)
- Topics: ajv, feathersjs, json-schema, mongodb, relationships, v5
- Language: JavaScript
- Homepage:
- Size: 1020 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# feathers-app
## Asunder Description
This is a nodejs backend template for feathersJS v5 using:
- NodeJS - recommended version node `18.18.x`
- Database - MongoDB
- Schema - [json-schema](https://json-schema.org/)
## Change Log:
### v0.3.0 - 27-03-24
- [x] removed `unique.js` hook, now utilizes mongodb's `createIndex` at the `.class.`.
- [x] added `getSchemaKeysHavingOperator.js` util.
- [x] modified (`trim.js` renamed to `trimmer.js`) hook to work with deeply nested schema options keywords.
### v0.2.0 - 26-03-24
- [x] adding two custom hooks. `unique` and `trim`. See `validator.js` for registering custom keywords and the hook files in `/hooks/`.
- [x] Added one-to-one relationship between `doors` and `hardwares` in `doors.schema.js`. `doors` refer to `hardwares` database.
## Getting Started
1. Make sure you have [NodeJS](https://nodejs.org/) and [npm](https://www.npmjs.com/) installed.
2. Install your dependencies
```
cd path/to/my-app
npm install
```
3. Start your app
```
npm run dev
```
## Testing
Run `npm test` and all your tests in the `test/` directory will be run.
## Scaffolding
This app comes with a powerful command line interface for Feathers. Here are a few things it can do:
```
$ npx feathers help # Show all commands
$ npx feathers generate service # Generate a new Service
```
## Help
For more information on all the things you can do with Feathers visit [docs.feathersjs.com](http://docs.feathersjs.com).