Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ixnur authored Dec 14, 2023
1 parent fba43b9 commit 1baa6ff
Showing 1 changed file with 41 additions and 35 deletions.
76 changes: 41 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,63 @@
OpenStockMate
# OpenStockMate

OpenStockMate is an open-source and free component inventory management application.
About

This project is developed by the community at mekatronik.org/forum. The goal is to enable users to effectively manage their electronic component inventories.
Features
## About

Component inventory management
Component inventory alert emails
Registration emails
Separate inventory page for each user
180 days password expiration
8-character case-sensitive password requirement
Activation email
Developed by the mekatronik.org/forum community, OpenStockMate is designed to empower users in effectively managing their electronic component inventories.

Installation
## Features

Clone the project to your computer.
- **Component Inventory Management:** Easily manage your electronic component inventory.
- **Component Inventory Alert Emails:** Receive alerts about your component stock.
- **Registration Emails:** Seamless user registration with confirmation emails.
- **Separate Inventory Page for Each User:** Personalized inventory management for every user.
- **Password Security:**
- 180 days password expiration
- 8-character case-sensitive requirement
- Activation email for added security

bash
## Installation

1. Clone the project to your computer.
2. download or git clone....

bash
**Navigate to the Project Directory:**

cd OpenStockMate
```bash
cd OpenStockMate
```

Install the necessary dependencies.
3. **Install Dependencies:**

bash
```bash
# Create and activate virtual environment (if necessary)
python -m venv venv # Linux
venv\Scripts\activate # Windows

# Create a virtual environment if necessary
python -m venv venv # Linux
venv\Scripts\activate # Windows
# Install required packages
pip install -r requirements.txt
```

# Activate the virtual environment
source venv/bin/activate # Linux
venv\Scripts\activate # Windows

# Install required packages
pip install -r requirements.txt

Create the database and start the application.

bash
4. **Create the Database and Start the Application:**

```bash
python manage.py migrate
python manage.py runserver
```

5. **Open the Application in Your Browser:**

Open your browser and go to http://127.0.0.1:8000/.
[http://127.0.0.1:8000/](http://127.0.0.1:8000/)

Contribution
## Contribution

If you would like to contribute to the project, feel free to get involved! :)
License
If you'd like to contribute to the project, your involvement is welcome! Feel free to join and contribute.
## License
This project is licensed under the [MIT License].
---
Feel free to copy and paste this directly into your README.md file, replacing `<github-username>` and other placeholders with the actual values. If you have any specific details or additional sections you'd like to include, please let me know!

0 comments on commit 1baa6ff

Please sign in to comment.