Although you can view this project on the site, it's no longer active or maintained. Still, you can open an issue or a PR if you find a critical bug, I'll fix it ASAP.
A simple Stock Management API that was built with Django Rest Framework. It has CRUD, schema, documents, API authentication and authorization features. It was my very first project and I developed it while learning Django, Django Rest Framework and back end development in general.
Depending on the choice of yours, you can clone the project in various ways. Either via IDE, Git Desktop or Git commands.
Whatever the case, make sure Git is installed and after cloning the project, you are at the same working directory with the project.
- Look below for cloning the project via bash:
$ git clone https://github.com/Ksenofanex/stock-management-api.git
$ cd stock-management-api
$ pwd
/stock-management-apiBefore installing the project, you need a proper .env file. The project's settings.py module is depending on these variables.
The project has a fictional env file for educational purposes. You can either manually create a .env file or enter the command below to the bash/terminal to clone a proper .env file:
$ cp .env.example .envAn example configuration for the .env file:
DEBUG=True
SECRET_KEY=itdb4-_wc!=*hgl3)h@v$#jy7bxingn(n+qklsdso%9yq&c5)!
- You can generate the
SECRET_KEYvia sites like Djecrety and add it to the.envfile.
Set DEBUG to True while developing and testing in local/testing environments. Otherwise, set DEBUG to False.
After properly configuring the environment variables, you can proceed to the Docker or Venv section to initialize the project.
Thanks to the magical technology of Docker, you can build and initialize the project with single command. Like hokus pokus!
- Make sure your OS contains Docker1 and Docker Compose2, Docker Desktop is open and your working directory is the same with the project.
$ pwd
/stock-management-api
$ docker-compose upWith that single line of command, Docker will take care of everything.
- After the building and initialization process, you must see this output:
Then you can start exploring the project from either http://localhost:8000/api/ or http://127.0.0.1:8000/api/. Happy coding!
Remember, you must approve the created objects from the admin panel in order them to be visible in the API.
You can access to the documentation of the project from this URLs (http://localhost:8000/swagger-docs/ or http://127.0.0.1:8000/swagger-docs/) to see all available endpoints.
You prefer the traditional way, ha? Oki doki, no judgements.
- Make sure your working directory is the same with the project and virtualenv package is installed in your OS.
Windows
> pwd
\stock-management-api
> pip install virtualenv
> virtualenv env
> .\env\Scripts\activate
> pip install -r requirements.txt
> python manage.py makemigrations
> python manage.py migrate
> python manage.py runserver
Linux
$ pwd
/stock-management-api
$ pip3 install virtualenv
$ python3 -m venv env
$ source env/bin/activate
$ pip3 install requirements.txt
$ python3 manage.py makemigrations
$ python3 manage.py migrate
$ python3 manage.py runserver- After the initialization process, you must see this output:
Then you can start exploring the project from either http://localhost:8000/api/ or http://127.0.0.1:8000/api/. Happy coding!
Remember, you must approve the created objects from the admin panel in order them to be visible in the API.
You can access to the documentation of the project from this URLs (http://localhost:8000/swagger-docs/ or http://127.0.0.1:8000/swagger-docs/) to see all available endpoints.