Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yaasiin-ayeva/d4d-express-mongo-boilerplate
Dev4Diversity Express API Boilerplate is aserver side element to handle apis. Runs with MongoDB database, Use Mongoose, Passport authentication & Custom seeders.
https://github.com/yaasiin-ayeva/d4d-express-mongo-boilerplate
boilerplate-node dev4diversity expressjs mongoose
Last synced: 19 days ago
JSON representation
Dev4Diversity Express API Boilerplate is aserver side element to handle apis. Runs with MongoDB database, Use Mongoose, Passport authentication & Custom seeders.
- Host: GitHub
- URL: https://github.com/yaasiin-ayeva/d4d-express-mongo-boilerplate
- Owner: yaasiin-ayeva
- License: mit
- Created: 2023-09-18T02:05:57.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-30T11:35:52.000Z (8 months ago)
- Last Synced: 2024-10-10T11:26:10.164Z (about 1 month ago)
- Topics: boilerplate-node, dev4diversity, expressjs, mongoose
- Language: TypeScript
- Homepage:
- Size: 122 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# d4d-express-mongo-boilerplate
Dev4Diversity Express API Boilerplate is aserver side element to handle apis. Runs with MongoDB database, Use Mongoose, Passport authentication & Custom seeders.
# Steps to run this project:
1. Run :
```bash
npm install
```
2. Setup your environment configurations after creating an .env file at the root of the project with :
```bash
cp .env.example .env
```
3. Finally Run :
```bash
npm run dev
```
## Project structure
You can check the link above for more information.
| Location | Content |
| --------------------- | -------------------------------------------------- |
| `/src/config` | DB, Passport, Loggers & environment Configurations |
| `/src/controllers` | Controllers functions for routes |
| `/src/middlewares` | Middlewares for controllers |
| `/src/models` | Project Models written with Mongoose schema |
| `/src/models/plugins` | Plugins for mongoose models |
| `/src/services` | Tier services for project |
| `/src/routes` | Contains Routes for each version of the API |
| `/src/seeders` | Seeders for some models |
| `/src/utils` | Exported Utils functions |
| `/src/validation` | Endpoints & Mongoose validators & helpers |
| `/src/index.ts` | API Entry Point with server configurations |
Please kindly respect this project architecture in your code maintenance and update documentation in case of any changes.
## IMPORTANT
Check `/postman` folder to get exported postman collection
[link-author]: https://github.com/yaasiin-ayeva
## TODO
- [ ] Write Unit tests