Skip to content

Commit 65cb5d5

Browse files
✨ created README.md file
1 parent ca9e08e commit 65cb5d5

1 file changed

Lines changed: 59 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# 🍵 CaffeineCode
2+
CaffeineCode is a Community website made using popular python web-development framework `django` ,
3+
This website is enclosed with ✍️ Tech-Blogs , 🎮 Playground (solve problems and write code) , ✨ Awesome projects showcase
4+
<br>
5+
6+
👀 Looking forward to developed this community, get register yourself through our website contact-us page 📞
7+
8+
Front-end : `HTML` `Bootstrap` `Ajax` `CSS` `Jquery` `JavaScript`
9+
<br>
10+
Back-end : `Python`
11+
12+
<br>
13+
14+
# ➕ Installation
15+
16+
Use the package manager [pip](https://pip.pypa.io/en/stable/) to install required packages.
17+
18+
> ⚠️ **NOTE** : **Recommedded to download all packages in a virtual python environment and third-party pacakages are also thier**
19+
<br>
20+
21+
```bash
22+
pip install -r requirements.txt
23+
```
24+
<br>
25+
26+
# 🔭 Usage
27+
## Setuping project
28+
Step 1 - Make database migrations
29+
<br>
30+
31+
```bash
32+
python manage.py makemigrations
33+
```
34+
Step 2 - Apply database migrations
35+
<br>
36+
37+
```bash
38+
python manage.py migrate
39+
```
40+
41+
Step 3 - Finally use this command to run-server on localhost
42+
<br>
43+
44+
```bash
45+
python manage.py runserver
46+
```
47+
48+
49+
# 🧑‍💻 Contributing
50+
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
51+
<br>
52+
53+
There are some cases, such as using this code for a business or something that is greater than a personal project,
54+
that we may be less comfortable saying yes to use this django project.
55+
If in doubt, please don't hesitate to ask the repo owner.
56+
57+
58+
# License
59+
This repo is lincense in [MIT](https://github.com/Developer-R-7/CaffeineCode/blob/main/LICENSE)

0 commit comments

Comments
 (0)