Skip to content

Latest commit

 

History

History
103 lines (61 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

103 lines (61 loc) · 2.27 KB
Raw

Contributing Guidelines

Before contributing, please read our Code of Conduct .

Figma Design Link

CSS BEM Convention

We use BEM (Block, Element, Modifier) Convention, please read documentation to keep css in order: CSS B.E.M. Convention Documentation .

Installation and Usage

  • Prerequisites

    • Python >= 3.8

    • VS Code or any other IDE

  • Fork the Repository

    Click on the fork button on the upper right corner to fork the repository.

  • Clone the Repository

    git clone https://github.com/{your-github-username}/imgman.git

cd imgman

  • Create and Activate New Virtual Environment

    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

  • Install the requirements

    pip install -r requirements.txt

  • Create .env File

    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.

  • Create Database and Tables

    python manage.py migrate

  • Run the Django Server

    python manage.py runserver

Pull Requests

We actively welcome your pull requests.

  1. Fork the repo and create your branch from main.

  2. If you've added code that should be tested, add tests.

  3. If you've changed APIs, update the documentation.

  4. Ensure the test suite passes.

  5. Make sure your code lints.

Issues

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.

License

By contributing to imgman, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.