LC Inventory Management

Open source inventory management system for personal or business use.
Live Demo · Fork Project

📝 About The Project

This is an open source inventory management system for personal or business use. It uses Clerk for authentication and Neon for the database. The project is built with Next.js, ShadCN, Clerk, Neon, TailwindCSS, Lucide and Tanstack Query. You can have multiple organizations and users with different permissions by your needs.

This project is currently in development and is not ready for production use and bugs are expected. Some features are not yet implemented and some are not fully implemented so expect some discrepancies.

(back to top)

🛠️ Made using

This section contains some of the most notable tools/libraries used in this project.

• 
• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

🏗️ Getting Started

How to run this project locally.

1. You will need to have Node.js installed on your machine. You can download it here.
2. Run the following command to install the necessary dependencies.

   npm install

3. Create a .env file in the root of the project and add the following variables:

   DATABASE_URL="postgresql://XXXXXXXXXX:[email protected]/XXXXXXXXXXXXXXX?sslmode=require"
   NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY="pk_test_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
   CLERK_SECRET_KEY="sk_test_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
   

4. Run the app in development mode.

   npm run dev

(back to top)

🗺️ Roadmap

• 🚢 Release project
• 📝 Make it more secure (read perms)
• 🧹 Split into more components
• ✏️ Add more functionality

(back to top)

⛑️ Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make the portfolio better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks!

1. Fork the Project
2. Change the project and add your files or changes (git add *)
3. Commit your Changes (git commit -m 'feat: Added XXXX to the XXX')
4. Push to the Branch (git push)
5. Open a Pull Request

🏆 Top contributors:

(back to top)

💌 Contact

Lazyllama - @Lazyllamaa - [email protected] Cyber - @Cyber

Project Link: https://github.com/lcholdings/lc-inventory-mgmt

(back to top)

🌟 Acknowledgments

Thanks to the following people for their help and inspiration:

• Readme Template
• Lucide Icons
• ShadCN
• Clerk
• Tanstack Query
• TailwindCSS
• Next.js
• React
• v0
• HC High Seas

(back to top)

This project is not affiliated with HCB