Skip to content

Commit a4a4a91

Browse files
committed
[chore] update readme installation manual
1 parent ea6bbac commit a4a4a91

File tree

2 files changed

+49
-0
lines changed

2 files changed

+49
-0
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,3 +92,6 @@ ENV/
9292
# sqlite
9393
*.sqlite3
9494
db.sqlite3
95+
96+
# ignore habitat results folder
97+
results/

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,48 @@
11
# django-rest-api
22
A REST api written in Django for people with deadlines
3+
4+
## Technologies used
5+
* [Django](https://www.djangoproject.com/): The web framework for perfectionists with deadlines (Django builds better web apps with less code).
6+
* [DRF](www.django-rest-framework.org/): A powerful and flexible toolkit for building Web APIs
7+
8+
9+
## Installation
10+
* If you wish to run your own build, first ensure you have python globally installed in your computer. If not, you can get python [here](https://www.python.org").
11+
* After doing this, confirm that you have installed virtualenv globally as well. If not, run this:
12+
```bash
13+
$ pip install virtualenv
14+
```
15+
* Then, Git clone this repo to your PC
16+
```bash
17+
$ git clone https://github.com/gitgik/django-rest-api.git
18+
```
19+
20+
* #### Dependencies
21+
1. Cd into your the cloned repo as such:
22+
```bash
23+
$ cd django-rest-api
24+
```
25+
2. Create and fire up your virtual environment:
26+
```bash
27+
$ virtualenv venv -p python3
28+
$ source venv/bin/activate
29+
```
30+
3. Install the dependencies needed to run the app:
31+
```bash
32+
$ pip install -r requirements.txt
33+
```
34+
4. Make those migrations work
35+
```bash
36+
$ python manage.py makemigrations
37+
$ python manage.py migrate
38+
```
39+
40+
* #### Run It
41+
Fire up the server using this one simple command:
42+
```bash
43+
$ python manage.py runserver
44+
```
45+
You can now access the file api service on your browser by using
46+
```
47+
http://localhost:8000/auth/
48+
```

0 commit comments

Comments
 (0)