FAQ.md

Quick Start Guide for Reddit Clone Project

Joining the project

Follow: https://github.com/pymasterspl/reddit/blob/dev/README.md#how-to-set-up#joining-the-project

Then you will receive write access to this repository and to project ClickUp.

Installation on Local Host

Follow: https://github.com/pymasterspl/reddit/blob/dev/README.md#how-to-set-up

Code Formatting Rules

The project follows PEP8 coding standards. To ensure code quality, use ruff to check your code before creating pull requests. Follow the Ruff section in readme:

https://github.com/pymasterspl/reddit/blob/dev/README.md#ruff-formatting-and-linting

Code Writing Rules

Follow:

https://github.com/pymasterspl/reddit/blob/dev/README.md#code

Tests

Follow:

https://github.com/pymasterspl/reddit/blob/dev/README.md#testing

Project Rules

The project uses the Git Flow approach for development. A video explaining what is Git Flow along with presentation is available on Discord: https://discord.com/channels/1035267230901997628/1135149223306858536/1136744608555089990.

Please read: https://github.com/pymasterspl/reddit/blob/dev/README.md#rules

Additional Resources

• Project readme: https://github.com/pymasterspl/reddit/blob/dev/README.md
• For Bootstrap framework: https://getbootstrap.com/
• For class-based views: https://akademiait.com.pl/ and https://www.youtube.com/watch?v=2S9-pvFBlBc&ab_channel=AkademiaIT
• For testing with pytest: https://www.youtube.com/watch?v=xn3wSM82fnA&ab_channel=AkademiaIT
• Task management in Clickup: https://app.clickup.com/9012000285/v/l/8cjgdgx-412

If you have any questions or need help, feel free to ask on Discord on the Reddit channel.