Welcome to the Arraytics Product Solution Backend! This project serves as the backbone for handling various functionalities related to Arraytics product solutions. It is built using technologies like Node.js, Express.js, MongoDB with Mongoose, and other essential libraries.
View the live site frontend here.
View the live site backend here.
View the API documentation on Postman here.
+-------------------+ +-----------------+
| Item | | User |
+-------------------+ +-----------------+
| _id: ObjectId | | _id: ObjectId |
| name: String | | name: String |
| created_at: Date | | email: String |
| created_by: String| | password: String|
+-------------------+ | created_at: Date|
| created_by: String|
+-----------------+
- POST /auth/signup: Register a new user. 📝
- POST /auth/login: Log in a user. 🔐
- GET /items: Get all items. 📋
- GET /items/:itemId: Get a specific item by ID. 📖
- POST /items/create-item: Create a new item. ✨
- PUT /items/:itemId: Update an item by ID. 🔄
- DELETE /items/:itemId: Delete an item by ID. 🗑️
- GET /users: Get all users. 🧑💼
- GET /users/:userId: Get a specific user by ID. 🧑💻
- POST /users/create-user: Create a new user. ➕
- PUT /users/:userId: Update a user by ID. 🔄
- DELETE /users/:userId: Delete a user by ID. 🗑️
Certainly! Here are the API endpoints and JSON data for the provided code with emojis:
POST /signup: Register a new user. 📝
- Endpoint:
/auth/signup
- JSON Data:
{ "username": "example", "email": "example@example.com", "password": "your_password" }
POST /login: Log in a user. 🔐
- Endpoint:
/auth/login
- JSON Data:
{ "email": "example@example.com", "password": "your_password" }
GET /items: Get all items. 📋
- Endpoint:
/items
GET /items/:itemId: Get a specific item by ID. 📖
- Endpoint:
/items/:itemId
POST /items/create-item: Create a new item. 📦
- Endpoint:
/items/create-item
- JSON Data:
{ "name": "New Item", "created_by": "user_id" }
PUT /items/:itemId: Update an item by ID. 🔄
- Endpoint:
/items/:itemId
- JSON Data:
{ "name": "Updated Item", "created_by": "user_id" }
DELETE /items/:itemId: Delete an item by ID. 🗑️
- Endpoint:
/items/:itemId
GET /users: Get all users. 📊
- Endpoint:
/users
GET /users/:userId: Get a specific user by ID. 🧑💻
- Endpoint:
/users/:userId
POST /users/create-user: Create a new user. 🧑🚀
- Endpoint:
/users/create-user
- JSON Data:
{ "name": "New User", "email": "newuser@example.com", "password": "user_password", "created_by": "admin_id" }
PUT /users/:userId: Update a user by ID. 🔄
- Endpoint:
/users/:userId
- JSON Data:
{ "name": "Updated User", "email": "updateduser@example.com", "password": "updated_password", "created_by": "admin_id" }
DELETE /users/:userId: Delete a user by ID. 🗑️
- Endpoint:
/users/:userId
User Model: 👤
{
"name": "String",
"email": "String",
"password": "String",
"created_at": "Date",
"created_by": "String"
}
Item Model: 📦
{
"name": "String",
"created_at": "Date",
"created_by": "String"
}
Features:
- Custom Authentication with JWT 🔐
- Role-Based Access Control (RBAC) 🛡️
- Item Management API 📦
- User Management API 👤
- Authentication Routes 🛡️
Technologies:
- Node.js 💻
- Express.js ⚡
- MongoDB with Mongoose 🐘
- Bcrypt for password hashing 🔑
- Body-parser for parsing incoming request bodies 📝
- CORS for enabling cross-origin resource sharing ⚙️
- Dotenv for environment variable management 🌐
- Nodemon for development server auto-reloading 🔄
- Zod for TypeScript-first schema declaration and validation 🏗️
Features:
- User Interface for Arraytics Product Solution Management System 🚀
- Authentication UI 🛡️
- Item Management UI 📦
- User Management UI 👤
Technologies:
- React for building user interfaces ⚛️
- Vite for frontend tooling and development 🛠️
- Chakra UI for building accessible and themeable UI components 👩🎨
- Emotion for styling components with JavaScript 💅
- Axios for making HTTP requests 🌐
- Framer Motion for creating smooth animations 🔄
- React Query for data fetching and state management 📊
- React Router for navigation 🚦
- React Icons for including popular icon sets 🎨
- Yup for form validation 📝
- SweetAlert2 for displaying beautiful alerts 🍬
- Tailwind CSS for utility-first styling 🎨
To make the installation process for both the frontend and backend repositories attractive, you can follow these steps:
-
Clone the Repository:
git clone https://github.com/Hamed-Hasan/Building-arraytics-product-solution-backend cd arraytics-product-solution-backend
-
Install Dependencies:
npm install
-
Set Environment Variables: Create a
.env
file in the root directory and add the necessary environment variables likeMONGODB_URI
,JWT_SECRET
, etc. -
Run the Application:
npm start
This will start the backend server.
-
Verify Backend Installation: Open your browser and go to http://localhost:5000 to verify that the backend server is running.
-
Clone the Repository:
git clone https://github.com/Hamed-Hasan/Building-arraytics-product-solution-frontend cd arraytics-product-solution-frontend
-
Install Dependencies:
npm install
-
Set Backend API URL: In the
.env
file or in your configuration, set theREACT_APP_API_URL
to the backend API URL (e.g.,http://localhost:5000
). -
Run the Application:
npm run dev
This will start the frontend development server.
-
Verify Frontend Installation: Open your browser and go to http://localhost:5471 to verify that the frontend application is running.
Now, you have both the backend and frontend up and running. You can explore the Arraytics Product Solution Management System by navigating through the provided routes and endpoints.
Feel free to reach out if you encounter any issues during the installation process or if you have any questions about the codebase!