Before contributing, please read our Code of Conduct .
We use BEM (Block, Element, Modifier) Convention, please read documentation to keep css in order: CSS B.E.M. Convention Documentation .
-
-
Python >= 3.8
-
VS Code or any other IDE
-
-
Click on the fork button on the upper right corner to fork the repository.
-
git clone https://github.com/{your-github-username}/imgman.git cd imgman
-
Refer to this guide or follow the below steps!
python -m venv venv
-
Windows
.\venv\Scripts\activate
-
Linux / Mac
source venv/bin/activate
note: you should be on the same dir as requirements.txt file
-
-
pip install -r requirements.txt
-
This project uses the Cloudinary service to store images. You can create a free account here and get your API keys.
Then, create a new .env file same as the .env.example file and fill in the required fields.
-
python manage.py migrate
-
python manage.py runserver
We actively welcome your pull requests.
-
Fork the repo and create your branch from
main
. -
If you've added code that should be tested, add tests.
-
If you've changed APIs, update the documentation.
-
Ensure the test suite passes.
-
Make sure your code lints.
We use GitHub issues to track public bugs.
Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.
By contributing to imgman, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.