Skip to content

Latest commit

 

History

History
101 lines (74 loc) · 2.25 KB

README.md

File metadata and controls

101 lines (74 loc) · 2.25 KB

🚀 Backend Projects

This repository contains multiple backend projects built using Node.js and TypeScript.

📂 Project Structure

node
├── short-hand-url       # 🔗 URL Shortener project
├── user-information     # 🧑‍💻 User Information management system

🛠️ Getting Started

📥 1. Clone the Repository

git clone https://github.com/your-username/backend-projects.git
cd backend-projects

📦 2. Install Dependencies

Each project has its own dependencies. Navigate to the respective folder and install them.

cd short-hand-url
npm install
cd ../user-information
npm install

🌍 3. Environment Variables

Each project requires a .env file. Create one in each project directory and configure the necessary environment variables.

📄 Example (.env for short-hand-url)

PORT=3000
MONGO_URI=mongodb://localhost:27017/short-hand-url

📋 Projects Overview

🔗 1. Short-Hand URL

A simple URL shortener using Node.js, Express, MongoDB, and TypeScript.

▶️ Run the Server

cd short-hand-url
npm run dev

The server will start on http://localhost:3000

🧑‍💻 2. User Information

A backend service to manage user information.

▶️ Run the Server

cd user-information
npm run dev

The server will start on http://localhost:4000

🧰 Tech Stack

  • 🟩 Node.js
  • 🔷 TypeScript
  • ⚡ Express.js
  • 🍃 MongoDB (Mongoose)
  • 🎯 ESLint & Prettier
  • 🌐 Dotenv for environment variables

🔧 Scripts

Each project has the following scripts in package.json:

🛠️ Script 📝 Description
npm run dev 🚀 Start the development server
npm run build 🔨 Compile TypeScript to JavaScript
npm start ▶️ Run the compiled JavaScript code
npm run lint ✅ Check code quality with ESLint

🐙 Connect with Me

📌 GitHub: Hello-ship-code 😊🔥

📜 License

This project is licensed under the MIT License.