Skip to content

Commit 6ea39b8

Browse files
committedSep 9, 2023
added installation guide and requirements file
1 parent fb3c296 commit 6ea39b8

File tree

2 files changed

+70
-1
lines changed

2 files changed

+70
-1
lines changed
 

‎README.md

+64-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,64 @@
1-
# django-rest-api-with-cbv
1+
# Django REST API With Class-Based Views
2+
3+
4+
## Project Setup on Your Computer
5+
6+
- Clone the repo to your computer by using the **git-clone** command.
7+
8+
```bash
9+
git clone git@github.com:makeuseofcode/django-pagination.git
10+
```
11+
12+
- Create a virtual environment for your dependencies.
13+
14+
**For Windows:**
15+
16+
```bash
17+
python -m venv env
18+
```
19+
20+
**For Linux and Mac:**
21+
22+
```bash
23+
python3 -m venv env
24+
```
25+
26+
- Activate your virtual environment.
27+
28+
**For Windows:**
29+
30+
```bash
31+
env\scripts\activate
32+
```
33+
34+
**For Linux and Mac:**
35+
36+
```bash
37+
source env/bin/activate
38+
```
39+
40+
**For Git Bash on Windows:**
41+
42+
```bash
43+
source env/scripts/activate
44+
```
45+
46+
- Install the dependencies in the **requirements.txt** file.
47+
48+
**For Windows:**
49+
50+
```bash
51+
pip install -r requirements.txt
52+
```
53+
54+
**For Linux and Mac:**
55+
56+
```bash
57+
pip3 install -r requirements.txt
58+
```
59+
60+
- Start your local server.
61+
62+
```bash
63+
python manage.py runserver
64+
```

‎requirements.txt

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
asgiref==3.7.2
2+
Django==4.2.5
3+
djangorestframework==3.14.0
4+
pytz==2023.3.post1
5+
sqlparse==0.4.4
6+
tzdata==2023.3

0 commit comments

Comments
 (0)