StackTally

"Smart management for stacked items,
find it fast, count it smarter."

Prerequisites

• Node.js (v18.0.0 or higher)
• npm (v9.0.0 or higher)
• MongoDB (v6.0 or higher)

Installation

1. Clone the repository

git clone https://github.com/j7sus/StackTally.git
cd stack-tally

2. Install dependencies

npm install

3 Start the development server and client

npm run dev

Once both the frontend and the backend are running open localhost:5173 in your browser. Have fun!

Useful Scripts

• npm run install-all → Install dependencies for both client and server
• npm run dev → Start both client and server in development mode
• npm run start → Start the server in production mode
• npm run seed → Populate the database with test data
• npm test → Run unit tests

Built With

• Frontend:

  • React - Used for building the dynamic user interface and managing components.
  • CSS Modules - Employed for styling components in a modular and maintainable way, preventing CSS conflicts.
  • GraphQL - Used for querying and fetching data from the backend API efficiently.
  • Figma - Used for designing the user interface and creating prototypes for the StackTally application.

• Backend:

  • Node.js - The runtime environment for the server-side logic and API.
  • Express.js - The web framework used to create the REST API endpoints and handle requests.
  • MongoDB - The database used to store the application's data persistently.
  • Mongoose - Provides a structured way to interact with MongoDB, defining models and schemas.
  • Apollo Server - The GraphQL server implementation, handling GraphQL queries and mutations.

• Other:

  • npm - Used for managing project dependencies and running scripts.
  • Git - Used for version control and collaboration.
  • Love, lots of love 🩶++;

REST API

• Deliveries:

  • GET /api/deliveries → Get all deliveries
  • POST /api/deliveries → Create a delivery

• Boxes:

  • GET /api/boxes/:numberBox/items → Get items in a box
  • POST /api/boxes → Create a new box

:)