Skip to content

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

License

Notifications You must be signed in to change notification settings

RaoofJM/nodejs-typescript-realworld-backend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

19 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿ’ป 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 TypeScript Express.js JWT NPM NodeJS MongoDB Redis Docker Postman

Feel free to explore and leverage these technologies for your own projects. ๐Ÿงช

๐Ÿ“„ License

This project is licensed under the MIT License.

๐Ÿ“ž Contact

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