Skip to content

Commit 64c6507

Browse files
committed
update README
1 parent 90582d9 commit 64c6507

2 files changed

Lines changed: 37 additions & 9 deletions

File tree

README.md

Lines changed: 36 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,11 @@
11
# tutorialdb
22
> A search engine for programming/dev tutorials.
33
4-
## Installation
4+
[![CodeFactor](https://www.codefactor.io/repository/github/bhupesh-v/tutorialdb/badge)](https://www.codefactor.io/repository/github/bhupesh-v/tutorialdb)
55

6-
1. Clone the repository.
6+
## Installation 🔮
77

8-
```bash
9-
git clone https://github.com/Bhupesh-V/tutorialdb.git
10-
```
11-
12-
2. Create virtual environment.
8+
1. Create virtual environment.
139

1410
**Linux:**
1511
```bash
@@ -19,6 +15,12 @@ virtualenv -p python3 venv && cd venv && source bin/activate
1915
**Windows:**
2016
```batch
2117
python -m venv venv && venv\Scripts\activate.bat
18+
```
19+
20+
2. Clone the repository.
21+
22+
```bash
23+
git clone https://github.com/Bhupesh-V/tutorialdb.git
2224
```
2325

2426
3. Install dependencies.
@@ -37,4 +39,30 @@ python manage.py migrate
3739

3840
```bash
3941
python manage.py runserver
40-
```
42+
```
43+
> For SECRET_KEY, follow below steps :
44+
1. Run `python manage.py shell`
45+
2. Do
46+
```python
47+
>>> from django.core.management.utils import get_random_secret_key
48+
>>> get_random_secret_key()
49+
'[GENERATED KEY]'
50+
51+
```
52+
3. Set this key in your Virtual Environment Variables.
53+
54+
55+
## 📝 License
56+
57+
This project is licensed under the MIT License. See the [LICENSE.md](LICENSE) file for details.
58+
59+
## Author
60+
61+
👥 **Bhupesh Varshney**
62+
63+
- Twitter: [@bhupeshimself](https://twitter.com/bhupeshimself)
64+
- Github: [@Bhupesh-V](https://github.com/Bhupesh-V)
65+
66+
## 👋 Contributing
67+
68+
Please read the [CONTRIBUTING](CONTRIBUTING.md) for the process for submitting pull requests to us.

tutorialdb/settings.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
# See https://docs.djangoproject.com/en/2.2/howto/deployment/checklist/
2121

2222
# SECURITY WARNING: keep the secret key used in production secret!
23-
SECRET_KEY = 'hiin&e&(d2+!7ujj^inh5*x-l1zlj!aav3sgqd)+5ka_^w31(z'
23+
SECRET_KEY = os.environ['SECRET_KEY']
2424

2525
# SECURITY WARNING: don't run with debug turned on in production!
2626
DEBUG = True

0 commit comments

Comments
 (0)