https://github.com/raoofjm/nodejs-typescript-realworld-backend

RealWorld Example of a NodeJS Rest API using TypeScript, MongoDB, Redis and Docker
https://github.com/raoofjm/nodejs-typescript-realworld-backend

docker docker-compose expressjs javascript joi jwt mongodb mongoose node nodejs redis rest-api restful-api typescript

Last synced: 12 days ago
JSON representation

RealWorld Example of a NodeJS Rest API using TypeScript, MongoDB, Redis and Docker

• Host: GitHub
• URL: https://github.com/raoofjm/nodejs-typescript-realworld-backend
• Owner: RaoofJM
• License: mit
• Created: 2023-05-13T21:12:16.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-06-19T00:29:11.000Z (over 1 year ago)
• Last Synced: 2024-12-03T15:16:35.144Z (2 months ago)
• Topics: docker, docker-compose, expressjs, javascript, joi, jwt, mongodb, mongoose, node, nodejs, redis, rest-api, restful-api, typescript
• Language: TypeScript
• Homepage:
• Size: 369 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 💻 nodejs-typescript-realworld-backend

This repository contains a sample RESTful API built with Node.js and TypeScript. It utilizes various technologies such as MongoDB, Redis, Express.js, and Docker. The project follows best practices and implements the DRY (Don't Repeat Yourself) principle, providing a solid foundation for backend development. 🌟

## 🚀 Getting Started

Follow the steps below to set up and run the project:

1. Make a copy of the `.env.example` file and rename it to `.env`.

2. Modify the environment variables in the `.env` file according to your specific requirements.

3. Once the configurations are complete, the project is ready to run. To execute the project using Docker, run the command `docker-compose up --build`. For local development, use either `npm start` or `npm run watch`. 🏃‍♂️

## 💻 Tech Stack

The project incorporates the following technologies:

![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E) ![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white) ![Express.js](https://img.shields.io/badge/express.js-%23404d59.svg?style=for-the-badge&logo=express&logoColor=%2361DAFB) ![JWT](https://img.shields.io/badge/JWT-black?style=for-the-badge&logo=JSON%20web%20tokens) ![NPM](https://img.shields.io/badge/NPM-%23000000.svg?style=for-the-badge&logo=npm&logoColor=white) ![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white) ![MongoDB](https://img.shields.io/badge/MongoDB-%234ea94b.svg?style=for-the-badge&logo=mongodb&logoColor=white) ![Redis](https://img.shields.io/badge/redis-%23DD0031.svg?style=for-the-badge&logo=redis&logoColor=white) ![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white) ![Postman](https://img.shields.io/badge/Postman-FF6C37?style=for-the-badge&logo=postman&logoColor=white)

Feel free to explore and leverage these technologies for your own projects. 🧪

## 📄 License

This project is licensed under the [MIT License](LICENSE).

## 📞 Contact

If you have any questions, suggestions, or need assistance, please feel free to reach out.