Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/unusualcodeorg/wimm-node-app
Modern NodeJS Backend Development - WhereIsMyMotivation - Nestjs Backend Architecture - Learn to build a modular and secure backend services using very popular Nestjs framework.
https://github.com/unusualcodeorg/wimm-node-app
backend backend-api backend-service express express-js expressjs mongodb mongoose nest nestjs nestjs-backend node node-js nodejs redis typescript vscode
Last synced: about 1 month ago
JSON representation
Modern NodeJS Backend Development - WhereIsMyMotivation - Nestjs Backend Architecture - Learn to build a modular and secure backend services using very popular Nestjs framework.
- Host: GitHub
- URL: https://github.com/unusualcodeorg/wimm-node-app
- Owner: unusualcodeorg
- License: apache-2.0
- Created: 2024-01-06T13:31:46.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-07-10T16:51:59.000Z (4 months ago)
- Last Synced: 2024-09-27T18:40:52.700Z (about 2 months ago)
- Topics: backend, backend-api, backend-service, express, express-js, expressjs, mongodb, mongoose, nest, nestjs, nestjs-backend, node, node-js, nodejs, redis, typescript, vscode
- Language: TypeScript
- Homepage: https://github.com/janishar/wimm-node-app
- Size: 2.04 MB
- Stars: 91
- Watchers: 4
- Forks: 18
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# NestJS Backend Architecture Project
[](https://github.com/unusualcodeorg/wimm-node-app/actions/workflows/docker_compose.yml)
## WhereIsMyMotivation
This is a complete production ready project to learn modern techniques and approaches to build a performant and secure backend API services. It is designed for web apps, mobile apps, and other API services.
## Framework
- NestJS
- Express Node
- Typescript
- Mongoose
- Mongodb
- Redis
- JsonWebToken
- Jest
- Docker
- Multer
## Highlights
- API key support
- Token based Authentication
- Role based Authorization
- Database dump auto setup
- vscode template support
- Unit Tests
- Integration Tests
- 75% plus Test Coverage
- Clean and modular codebase
## Notes
A few things are added to aid the learning process
- disk submodule is added to provide images
- database dump is added to seed the database
# About Project
WhereIsMyMotivation is a concept where you see videos and quotes that can inspire you everyday. You will get information on great personalities and make them your perceived mentors. You can also subscribe to topics of your interests.
You can track your happiness level and write down daily journals. You can also share things of interest from web to store in your motivation box.
Using this app can bring a little bit of happiness and energy to live an inspired life.
## Read the Article to understand this project
[Mastering NestJS — Building an Effective REST API Backend](https://medium.com/@janishar.ali/mastering-nestjs-building-an-effective-rest-api-backend-8a5add59c2f5)
## Android App using this backend
The Android App using this backend is also open-sourced. You can find the project here: [Modern Android Development - WhereIsMyMotivation](https://github.com/unusualcodeorg/wimm-android-app)
## Request-Response Flow
# Installation Instruction
vscode is the recommended editor - dark theme
### Get the repo
```bash
# clone repository recursively
git clone https://github.com/unusualcodeorg/wimm-node-app.git --recursive
```
### Install libraries
```bash
$ npm install
```
### Run Docker Compose
- Install Docker and Docker Compose. [Find Instructions Here](https://docs.docker.com/install/).
```bash
# install and start docker containers
docker-compose up --build
```
- You will be able to access the api from http://localhost:3000
### Run Tests
```bash
docker exec -t tester npm run test:cov
```
If having any issue
- Make sure 3000 port is not occupied else change PORT in **.env** file.
- Make sure 27017 port is not occupied else change DB_PORT in **.env** file.
- Make sure 6379 port is not occupied else change REDIS_PORT in **.env** file.
## Run on the local machine
Change the following hosts in the **.env** and **.env.test**
- DB_HOST=localhost
- REDIS_HOST=localhost
Best way to run this project is to use the vscode `Run and Debug` button. Scripts are available for debugging and template generation on vscode.
```bash
$ npm install
```
### Running the app
```bash
# development
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod
```
### Test
```bash
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
```
## API DOC
[](https://documenter.getpostman.com/view/1552895/2s9YymH5MR)
## Minimalistic version of this project
If you want to use plain Express.js to create the same project explore the Minimalistic version of this project
[Minimalistic Backend Development - WhereIsMyMotivation](https://github.com/unusualcodeorg/wimm-node-app-minimalistic)
## Find this project useful ? :heart:
* Support it by clicking the :star: button on the upper right of this page. :v:
## More on YouTube channel - Unusual Code
Subscribe to the YouTube channel `UnusualCode` for understanding the concepts used in this project:
[](https://www.youtube.com/@unusualcode)
## Contribution
Please feel free to fork it and open a PR.