https://github.com/cerberusprogrammer/clean_stock_api

Backend for manage a simple stock enterprise
https://github.com/cerberusprogrammer/clean_stock_api

backend django python stock stock-data stock-market stocks

Last synced: 9 days ago
JSON representation

Backend for manage a simple stock enterprise

• Host: GitHub
• URL: https://github.com/cerberusprogrammer/clean_stock_api
• Owner: CerberusProgrammer
• Created: 2024-06-18T20:58:32.000Z (5 months ago)
• Default Branch: master
• Last Pushed: 2024-06-28T23:54:18.000Z (5 months ago)
• Last Synced: 2024-06-29T00:41:16.322Z (5 months ago)
• Topics: backend, django, python, stock, stock-data, stock-market, stocks
• Language: Python
• Homepage:
• Size: 81.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
📝 **Clean Stock API**

👋 Welcome to the Clean Stock API!

📖 **Description**

The Clean Stock API is a powerful tool for managing and tracking stock inventory. It provides a clean and intuitive interface to perform various operations such as adding, updating, and deleting stock items. With its robust features, it simplifies the process of inventory management for businesses of all sizes.

🚀 **Getting Started**

To run the Clean Stock API with Django, follow these steps:

1. Clone the repository:

   ```bash

   git clone https://github.com/cerberusprogrammer/clean-stock-api

   ```

2. Setup an environment

   ```bash

   python -m venv venv

   source venv/bin/activate

   ```

3. Install the dependencies:

   ```bash

   pip install -r requirements.txt

   ```

4. (Optional) Run the tests to check usability

   ```bash

   python manage.py test

   ```

5. Start the server:

   ```bash

   python manage.py runserver

   ```

6. Open your favorite browser and navigate to `http://localhost:8000` to access the Clean Stock API.

## Testing

### Global Testing

- To run every test file, just run:

  > global testing: python3 manage.py test

- If you need to check only one test file (Or more), run:

  > python3 manage.py test stock.tests.test_category_model

📚 **API Documentation**

For detailed information on the available endpoints and how to use them, please refer to the [API documentation](https://localhost/api/docs/).

📃 **License**

This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).

📧 **Contact**

If you have any questions or suggestions, feel free to reach out to us at [[email protected]](mailto:[email protected]).

🌟 **Enjoy using the Clean Stock API!**