📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 [Mineral Traceability & Inventory Management Software backend]

[Mineral Traceability * Inventory Management Software] This software was designed to meet the needs for ICGLR local mineral processors. It has a number of features from recording new mineral entries from miners to making shipment to international buyers. It has great user-friendly interface for smooth navigation.

🛠 Built With

Tech Stack

Client

• Nodejs
• Expressjs
• Mongoose
• Syncfusion
• MongoDB
• Jest (Testing)

Key Features

• Protected with user authentication
• Uses Google Authenticator to generate one time login OTP
• Records mineral entries
• Records suppliers
• Records Mine Tags
• Records Negociant Tags
• Generates lab report (MS DOCUMENT)
• Generates tag list, negociant tag list
• Generates invoices
• Tracks the changes in stock balances for managed different minerals
• Provides general settings for the app
• Allow access based on permissions for the user
• Track user's activities for transparency

(back to top)

🚀 Live Demo

Click here to view a live demo of the project. Click here to get to the frontend repository. demo email: [email protected]
demo password: moonlover35

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

You need to have git installed and the desired code editor

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/edenlisk/mining-company-management-system-backend.git

Install

Install this project with:

  cd my-folder
  npm install

Usage

Before running the project, make sure you add .env file with the following variables

NODE_ENV = 
PORT = 
MONGO_URL = 
JWT_SECRET_KEY = 
MONGO_URI_TEST=
EXPIRES_IN = 
JWT_COOKIE_EXPIRES_IN = 
EMAIL_PUBLIC_KEY = 
EMAIL_PRIVATE_KEY = 
EMAIL_SERVICE_ID = 
PASSWORD_RESET_EMAIL_TEMPLATE_ID = 
EMAIL_FROM = 
IMAGEKIT_ID = 
IMAGEKIT_PRIVATE_KEY = 
IMAGEKIT_PUBLIC_KEY = 
TOTP_SECRET = 

To run the project in development mode, execute the following command:

  npm start:dev

Deployment

You can run the project in production mode using:

    npm start:prod

Run tests

You can run tests by using the following command:

    npm run test

(back to top)

👥 Authors

👤 Edenlisk

• GitHub: @Edenlisk

• Twitter: @Edenlisk

  👤 Josue

• GitHub: @Josue16

• Twitter: @Josue16

(back to top)

🔭 Future Features

• Add suppliers section (Dashboard)
• Add Accounting functionalities

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project kindly consider giving ⭐

(back to top)

🙏 Acknowledgments

We would like to thank Venant Nsanzimfura who guided us throughout development process.

(back to top)

📝 License

This project is MIT licensed.

(back to top)