Skip to content

GerardAlbajar/BACK_The-Factory

Repository files navigation

The Factory API

Welcome to The Factory API! This project provides endpoints to manage users, inventory, and factory operations. It offers functionalities such as user authentication, managing inventory parts and assemblies, and interacting with the factory's production process.

Getting Started

To get started with The Factory API, follow these steps:

  1. Clone the repository:

git clone https://github.com/isdi-coders-2022/Gerard-Albajar_Back-Final-Project-202204-BCN.git

  1. Navigate into the project directory:

cd Gerard-Albajar_Back-Final-Project-202204-BCN

markdown Copy code

  1. Install dependencies:

npm install

  1. Start the server:

npm start

  1. Access the API endpoints using the provided routes.

API Endpoints

  • User Login: POST /user/login
  • User Registration: POST /user/register
  • Get All Users: GET /users
  • Get User Inventory: GET /inventory/:userId
  • Get All Astro Parts: GET /astroparts
  • Get All Astros: GET /astros
  • Create Perfect Astro: POST /inventory/:userId/perfect/:astroPartId
  • Delete Perfect Astro: DELETE /inventory/:userId/perfect/:astroPartId
  • Create Part: POST /inventory/:userId/part/:astroPartId
  • Delete Part: DELETE /inventory/:userId/part/:astroPartId
  • Create Perfect Part: POST /inventory/:userId/perfect/:astroPartId
  • Delete Perfect Part: DELETE /inventory/:userId/perfect/:astroPartId

Testing

To run tests for The Factory API, use the following command:

npm test

Contributing

Contributions to The Factory API are welcome! If you encounter any bugs, have feature requests, or want to contribute code improvements, feel free to open an issue or submit a pull request.

License

This project is licensed under the ISC License.


Note: This API is a project developed by Gerard Albajar for managing factory operations and is not affiliated with any real-world factory or organization.