Skip to content

README.md

Latest commit

 

History

History
75 lines (56 loc) · 1.94 KB

README.md

File metadata and controls

75 lines (56 loc) · 1.94 KB
Raw

🚀 Inprocode Server - Node.js Backend with Sequelize & MySQL

This project is a backend application built using Node.js, Sequelize ORM, and MySQL, fully written in TypeScript. It provides a scalable and structured backend solution for managing data with a relational database.

🌟 Features

  • 🖥️ Node.js - Fast and efficient server runtime.
  • 📦 Sequelize ORM - Simplifies database operations.
  • 🛢️ MySQL - Reliable relational database.
  • 🔍 TypeScript - Ensures type safety and modern JavaScript features.
  • 🔥 Nodemon - Automatic server restart during development.

🔧 Prerequisites

Ensure you have the following installed before running the project:

  • Node.js (version 14 or higher)
  • npm (version 6 or higher)
  • MySQL (version 5.7 or higher)

⚡ Getting Started

1️⃣ Clone the Repository

git clone https://github.com/adptCode/Inprocode_server.git
cd Inprocode_server

2️⃣ Install Dependencies

npm install

3️⃣ Set Up the Database

  1. Open MySQL Admin and create a new database named calcioapp.
  2. Import the provided calcioapp.sql file into the database.

4️⃣ Running the Application

Start the server in development mode with Nodemon:

nodemon dist/index.js

For production mode:

node dist/index.js

📂 Project Structure

Inprocode_server/
│── src/
│   ├── models/        # Sequelize models
│   ├── routes/        # API endpoints
│   ├── controllers/   # Business logic
│   ├── config/        # Database configuration
│   ├── index.ts       # Main entry point
│── dist/              # Compiled TypeScript files
│── calcioapp.sql      # Database schema
│── package.json       # Project dependencies

📜 License

This project is open-source and available under the MIT License.

🚀 Happy coding!