/entity

Primary LanguageJavaScript

# Entity API

This repository contains the source code for the Entity API.

## Description

The Entity API is designed to manage entities with CRUD operations (Create, Read, Update, Delete).

## Installation

1. Clone the repository:
   ```bash
   git clone https://github.com/khaledhelmyg/entity.git
   ```

  1. Install dependencies:

    npm install

  2. Set up environment variables:

    • Create a .env file in the root directory.
    • Define environment variables like PORT, APP_HOST, NODE_ENV, MONGO_URI, MONGO_URI_TEST, etc.

  3. Run the dev server:

    npm run dev

  4. Start the server:

    npm start

Endpoints

  • POST /entity: Create a new entity.
  • GET /entity: Get all entities.
  • GET /entity/:id: Get an entity by ID.
  • PUT /entity/:id: Update an entity by ID.
  • DELETE /entity/:id: Delete an entity by ID.
  • you can find the postamn file for more guid on config folder

Technologies Used

  • Node.js
  • Express.js
  • MongoDB
  • cors

Contributing

Contributions are welcome! Please follow the Contributing Guidelines.