Skip to content

Commit 820d617

Browse files
committedNov 1, 2022
Feat: CSS BEM convention
added into the CONTRIBUTING.md
1 parent b5fccdd commit 820d617

File tree

1 file changed

+45
-39
lines changed

1 file changed

+45
-39
lines changed
 

‎CONTRIBUTING.md

+45-39
Original file line numberDiff line numberDiff line change
@@ -3,72 +3,78 @@
33
Before contributing, please read our [Code of Conduct](CODE_OF_CONDUCT.md) .
44

55
## Figma Design Link
6+
67
- [Figma Link](https://www.figma.com/file/N1GUOSfNsqb8NTInxXj75K/Imgman-Project?node-id=0%3A1)
78

8-
## Installation and Usage
9+
## CSS BEM Convention
910

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/) .
1113

12-
- Python >= 3.8
14+
## Installation and Usage
1315

14-
- VS Code or any other IDE
16+
- ### Prerequisites
1517

16-
- ### Fork the Repository
18+
- Python >= 3.8
1719

18-
Click on the fork button on the upper right corner to fork the repository.
20+
- VS Code or any other IDE
1921

20-
- ### Clone the Repository
22+
- ### Fork the Repository
2123

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.
2425

25-
cd imgman
26-
```
26+
- ### Clone the Repository
2727

28-
- ### Create and Activate New Virtual Environment
28+
```bash
29+
git clone https://github.com/{your-github-username}/imgman.git
2930

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+
```
3133

32-
```bash
33-
python -m venv venv
34-
```
34+
- ### Create and Activate New Virtual Environment
3535

36-
- Windows
36+
Refer to this [guide](https://www.freecodecamp.org/news/how-to-setup-virtual-environments-in-python/) or follow the below steps!
3737

38-
```bash
39-
.\venv\Scripts\activate
40-
```
38+
```bash
39+
python -m venv venv
40+
```
4141

42-
- Linux / Mac
43-
```bash
44-
source venv/bin/activate
45-
```
42+
- Windows
4643

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+
```
5047

48+
- Linux / Mac
5149
```bash
52-
pip install -r requirements.txt
50+
source venv/bin/activate
5351
```
5452

55-
- ### Create .env File
53+
**_note: you should be on the same dir as requirements.txt file_**
5654

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
5856

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+
```
6060

61-
- ### Create Database and Tables
61+
- ### Create .env File
6262

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.
6664

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.
6866

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+
```
7278

7379
## Pull Requests
7480

0 commit comments

Comments
 (0)
Please sign in to comment.