A basic inventory management app built with MERN stack.
🟡 Note: Backend is running on a free instance on Render and may take some time to spin up. If the website is unaccessible for some reason, you can checkout some screenshots of the website here.
- Jamstack architecture
- Sorting and filtering capabilities for categories
- CRUD operations on items and categories
- Dynamic dashboard with charts
- Form validation on client-side and server-side
- User authentication on server-side when deleting item or category
- Mobile-responsive UI
- SEO optimized
Clone repository using Git (or otherwise):
git clone [email protected]:creme332/invento.gitNavigate to project:
cd inventoTo install backend dependencies:
cd server
npm installIf you don't already have a MongoDB database named invento, create one with MongoDB Atlas. Set the initial collection as Collection0.
In the server folder create a .env file with the following contents:
# Replace with mongo connection string
MONGO_STRING="mongodb+srv://cooluser:[email protected]/invento?retryWrites=true&w=majority"
ADMIN_KEY="1234" # Admin key to delete item/category🔴 Note: Do not forget the
invento?option in your connection string.
Create required database and add sample data:
node populatedb🟢 Note: You may now delete the previously created collection
Collection0.
To start local server:
npm run devBackend is deployed at http://localhost:3001.
To install dependencies for frontend:
cd client
npm installTo run the development server locally:
npm run devFrontend is deployed at http://localhost:3000.
The API (production) is deployed at https://invento-backend.onrender.com/.
| Endpoint | Meaning |
|---|---|
GET /items |
Get the list of items in the inventory. |
GET /items/total |
Get the total number of items in the inventory. |
GET /items/grouped-by-status |
Get the number of items for each status. |
GET /items/grouped-by-category |
Get the number of items for each category. |
GET /item/{id} |
Get the item with ID id. |
GET /items/recent/{n} |
Get the last n items created. |
GET /categories |
Get the list of item categories. |
GET /category/{id} |
Get the category with ID id. |
GET /categories/total |
Get the total number of categories. |
POST /item/create |
POST request for creating an item. |
POST /category/create |
POST request for creating a category. |
POST /item/{id}/update |
POST request for updating an item with ID id. |
POST /category/{id}/update |
POST request for updating a category with ID id. |
POST /item/{id}/delete |
POST request for deleting an item with ID id. |
POST /category/{id}/delete |
POST request for deleting a category with ID id. |
- Create a common re-usable function that calls API
- Add sorting and filtering capabilities on items page
- Add image upload feature using multer.
- Require user authentication to upload image
- Use typescript in backend