Skip to content

README.md

Latest commit

 

History

History
102 lines (68 loc) · 2.29 KB

README.md

File metadata and controls

102 lines (68 loc) · 2.29 KB

Petchain_api

Handles all contributions related to the server-side logic, APIs, or blockchain interactions of PetChain

🛠 Tech Stack

  • Framework: NestJS (TypeScript)
  • Database: PostgreSQL
  • ORM: TypeORM

🚀 Getting Started

Before diving in, check out our Contribution Guide to understand how you can contribute to PetChain across all repos.

📦 Installation

Set up the repo and install dependencies in the right order to get project up and running locally

# Clone the repository
git clone https://github.com/petchain/backend.git
cd backend

# Install dependencies
npm install
# or
yarn install

▶️ Run the Application

This shows how to start the backend server in different modes

Development Mode

npm run start:dev
# or
yarn start:dev

Watch Mode (Hot Reload)

npm run start:debug
# or
yarn start:debug

🧰 Useful NestJS CLI Commands

These are shortcuts and tools you need to work more efficiently with NestJS

# Generate a module
nest g module <module-name>

# Generate a service
nest g service <service-name>

# Generate a controller
nest g controller <controller-name>

🗂 Project Structure

src/
├── app.controller.ts
├── app.module.ts
├── app.service.ts
└── main.ts

🤝 Contributing

We’re excited to have you contribute! Check out our Contribution Guide to explore:

  • ✅ Code of Conduct
  • 🧭 Step-by-step contribution process
  • 📋 Open tasks and other ways to get involved

🔗 Related Repositories

Explore other parts of the PetChain ecosystem:

📫 Contact & Community

For feedback, questions or collaboration:

⭐️ Star this repo to stay updated on new features and releases.