|
3 | 3 | Before contributing, please read our [Code of Conduct](CODE_OF_CONDUCT.md) .
|
4 | 4 |
|
5 | 5 | ## Figma Design Link
|
| 6 | + |
6 | 7 | - [Figma Link](https://www.figma.com/file/N1GUOSfNsqb8NTInxXj75K/Imgman-Project?node-id=0%3A1)
|
7 | 8 |
|
8 |
| -## Installation and Usage |
| 9 | +## CSS BEM Convention |
9 | 10 |
|
10 |
| -- ### Prerequisites |
| 11 | +We use BEM (Block, Element, Modifier) Convention, |
| 12 | +please read documentation to keep css in order: [CSS B.E.M. Convention Documentation](https://getbem.com/) . |
11 | 13 |
|
12 |
| - - Python >= 3.8 |
| 14 | +## Installation and Usage |
13 | 15 |
|
14 |
| - - VS Code or any other IDE |
| 16 | +- ### Prerequisites |
15 | 17 |
|
16 |
| -- ### Fork the Repository |
| 18 | + - Python >= 3.8 |
17 | 19 |
|
18 |
| - Click on the fork button on the upper right corner to fork the repository. |
| 20 | + - VS Code or any other IDE |
19 | 21 |
|
20 |
| -- ### Clone the Repository |
| 22 | +- ### Fork the Repository |
21 | 23 |
|
22 |
| - ```bash |
23 |
| - git clone https://github.com/{your-github-username}/imgman.git |
| 24 | + Click on the fork button on the upper right corner to fork the repository. |
24 | 25 |
|
25 |
| - cd imgman |
26 |
| - ``` |
| 26 | +- ### Clone the Repository |
27 | 27 |
|
28 |
| -- ### Create and Activate New Virtual Environment |
| 28 | + ```bash |
| 29 | + git clone https://github.com/{your-github-username}/imgman.git |
29 | 30 |
|
30 |
| - Refer to this [guide](https://www.freecodecamp.org/news/how-to-setup-virtual-environments-in-python/) or follow the below steps! |
| 31 | + cd imgman |
| 32 | + ``` |
31 | 33 |
|
32 |
| - ```bash |
33 |
| - python -m venv venv |
34 |
| - ``` |
| 34 | +- ### Create and Activate New Virtual Environment |
35 | 35 |
|
36 |
| - - Windows |
| 36 | + Refer to this [guide](https://www.freecodecamp.org/news/how-to-setup-virtual-environments-in-python/) or follow the below steps! |
37 | 37 |
|
38 |
| - ```bash |
39 |
| - .\venv\Scripts\activate |
40 |
| - ``` |
| 38 | + ```bash |
| 39 | + python -m venv venv |
| 40 | + ``` |
41 | 41 |
|
42 |
| - - Linux / Mac |
43 |
| - ```bash |
44 |
| - source venv/bin/activate |
45 |
| - ``` |
| 42 | + - Windows |
46 | 43 |
|
47 |
| - **_note: you should be on the same dir as requirements.txt file_** |
48 |
| - |
49 |
| -- ### Install the requirements |
| 44 | + ```bash |
| 45 | + .\venv\Scripts\activate |
| 46 | + ``` |
50 | 47 |
|
| 48 | + - Linux / Mac |
51 | 49 | ```bash
|
52 |
| - pip install -r requirements.txt |
| 50 | + source venv/bin/activate |
53 | 51 | ```
|
54 | 52 |
|
55 |
| -- ### Create .env File |
| 53 | + **_note: you should be on the same dir as requirements.txt file_** |
56 | 54 |
|
57 |
| - This project uses the [Cloudinary](https://cloudinary.com) service to store images. You can create a free account [here](https://cloudinary.com/users/register/free) and get your API keys. |
| 55 | +- ### Install the requirements |
58 | 56 |
|
59 |
| - Then, create a new .env file same as the [.env.example](.env.example) file and fill in the required fields. |
| 57 | + ```bash |
| 58 | + pip install -r requirements.txt |
| 59 | + ``` |
60 | 60 |
|
61 |
| -- ### Create Database and Tables |
| 61 | +- ### Create .env File |
62 | 62 |
|
63 |
| - ```bash |
64 |
| - python manage.py migrate |
65 |
| - ``` |
| 63 | + This project uses the [Cloudinary](https://cloudinary.com) service to store images. You can create a free account [here](https://cloudinary.com/users/register/free) and get your API keys. |
66 | 64 |
|
67 |
| -- ### Run the Django Server |
| 65 | + Then, create a new .env file same as the [.env.example](.env.example) file and fill in the required fields. |
68 | 66 |
|
69 |
| - ```bash |
70 |
| - python manage.py runserver |
71 |
| - ``` |
| 67 | +- ### Create Database and Tables |
| 68 | + |
| 69 | + ```bash |
| 70 | + python manage.py migrate |
| 71 | + ``` |
| 72 | + |
| 73 | +- ### Run the Django Server |
| 74 | + |
| 75 | + ```bash |
| 76 | + python manage.py runserver |
| 77 | + ``` |
72 | 78 |
|
73 | 79 | ## Pull Requests
|
74 | 80 |
|
|
0 commit comments