Skip to content

Commit 9e5fcb5

Browse files
committed
Update README.md file
1 parent 9595d7c commit 9e5fcb5

File tree

1 file changed

+29
-89
lines changed

1 file changed

+29
-89
lines changed

README.md

+29-89
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,3 @@
1-
<!-- # Real Time Chat with Django
2-
Real Time Chat App is made using Django to communicate with members in Real Time.
3-
4-
## Prerequisits
5-
6-
Before cloning/forking this project, make sure you have the following tools installed:
7-
8-
- [Git](https://git-scm.com/downloads)
9-
- [Python](https://www.python.org/downloads/)
10-
11-
## Installation
12-
13-
1. Fork the project
14-
15-
2. Clone the project
16-
```bash
17-
git clone https://github.com/VigneshVicky97/Real-Time-Chat-with-Django.git
18-
```
19-
4. Navigate to the project directory
20-
```bash
21-
cd Real-Time-Chat-with-Django
22-
```
23-
5. Install the dependencies
24-
```bash
25-
pip install -r requirements.txt
26-
```
27-
6. Run the project
28-
```bash
29-
cd DjangoChat
30-
python manage.py runserver
31-
```
32-
33-
## Contributing
34-
35-
Pull requests are welcome. For major changes, please open an issue first
36-
to discuss what you would like to change.
37-
38-
## License
39-
40-
[MIT](https://github.com/VigneshVicky97/Real-Time-Chat-with-Django/blob/main/LICENSE) -->
41-
42-
43-
44-
451

462

473
<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
@@ -64,13 +20,6 @@ to discuss what you would like to change.
6420
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
6521
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
6622
-->
67-
[![Contributors][contributors-shield]][contributors-url]
68-
[![Forks][forks-shield]][forks-url]
69-
[![Stargazers][stars-shield]][stars-url]
70-
[![Issues][issues-shield]][issues-url]
71-
[![MIT License][license-shield]][license-url]
72-
[![LinkedIn][linkedin-shield]][linkedin-url]
73-
7423

7524

7625
<!-- PROJECT LOGO -->
@@ -84,15 +33,15 @@ to discuss what you would like to change.
8433

8534
<p align="center">
8635
Real Time Chat App is made using Django to communicate with members in Real Time.
87-
<br />
36+
<!-- <br />
8837
<a href="https://github.com/github_username/repo_name"><strong>Explore the docs »</strong></a>
8938
<br />
9039
<br />
9140
<a href="https://github.com/github_username/repo_name">View Demo</a>
9241
·
9342
<a href="https://github.com/github_username/repo_name/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
9443
·
95-
<a href="https://github.com/github_username/repo_name/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>
44+
<a href="https://github.com/github_username/repo_name/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a> -->
9645
</p>
9746
</div>
9847

@@ -116,11 +65,8 @@ to discuss what you would like to change.
11665
</ul>
11766
</li>
11867
<li><a href="#usage">Usage</a></li>
119-
<li><a href="#roadmap">Roadmap</a></li>
12068
<li><a href="#contributing">Contributing</a></li>
12169
<li><a href="#license">License</a></li>
122-
<li><a href="#contact">Contact</a></li>
123-
<li><a href="#acknowledgments">Acknowledgments</a></li>
12470
</ol>
12571
</details>
12672

@@ -131,22 +77,15 @@ to discuss what you would like to change.
13177

13278
[![Product Name Screen Shot][product-screenshot]](https://example.com)
13379

134-
Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: `github_username`, `repo_name`, `twitter_handle`, `linkedin_username`, `email_client`, `email`, `project_title`, `project_description`
80+
A Real Time Chat App is made using Django to communicate with members in Real Time. Mainly used within Team members during Normal conversation and project discussions.
13581

13682
<p align="right">(<a href="#readme-top">back to top</a>)</p>
13783

13884

13985

14086
### Built With
14187

142-
* [![Next][Next.js]][Next-url]
143-
* [![React][React.js]][React-url]
144-
* [![Vue][Vue.js]][Vue-url]
145-
* [![Angular][Angular.io]][Angular-url]
146-
* [![Svelte][Svelte.dev]][Svelte-url]
147-
* [![Laravel][Laravel.com]][Laravel-url]
148-
* [![Bootstrap][Bootstrap.com]][Bootstrap-url]
149-
* [![JQuery][JQuery.com]][JQuery-url]
88+
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/Django)
15089

15190
<p align="right">(<a href="#readme-top">back to top</a>)</p>
15291

@@ -155,31 +94,39 @@ Here's a blank template to get started: To avoid retyping too much info. Do a se
15594
<!-- GETTING STARTED -->
15695
## Getting Started
15796

158-
This is an example of how you may give instructions on setting up your project locally.
15997
To get a local copy up and running follow these simple example steps.
16098

16199
### Prerequisites
162100

163-
This is an example of how to list things you need to use the software and how to install them.
164-
* npm
165-
```sh
166-
npm install npm@latest -g
167-
```
101+
102+
* Python 3.12.0
103+
168104

169105
### Installation
170106

171-
1. Get a free API Key at [https://example.com](https://example.com)
172-
2. Clone the repo
107+
1. Clone the repo
173108
```sh
174109
git clone https://github.com/VigneshVicky97/Real-Time-Chat-with-Django.git
175110
```
111+
2. Install the dependencies
112+
```sh
113+
pip install -r requirements.txt
114+
```
176115
3. Navigate to the project directory
177116
```sh
178117
cd Real-Time-Chat-with-Django
179118
```
180-
4. Install the dependencies
119+
4. Make migrations
181120
```sh
182-
pip install -r requirements.txt
121+
python manage.py makemigrations
122+
```
123+
5. Migrate
124+
```sh
125+
python manage.py migrate
126+
```
127+
6. Create superuser
128+
```sh
129+
python manage.py createsuperuser
183130
```
184131
5. Run the project
185132
```sh
@@ -234,17 +181,10 @@ Distributed under the MIT License. See `LICENSE.txt` for more information.
234181
[product-screenshot]: images/screenshot.png
235182
[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
236183
[Next-url]: https://nextjs.org/
237-
[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
238-
[React-url]: https://reactjs.org/
239-
[Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D
240-
[Vue-url]: https://vuejs.org/
241-
[Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white
242-
[Angular-url]: https://angular.io/
243-
[Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00
244-
[Svelte-url]: https://svelte.dev/
245-
[Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
246-
[Laravel-url]: https://laravel.com
247-
[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
248-
[Bootstrap-url]: https://getbootstrap.com
249-
[JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
250-
[JQuery-url]: https://jquery.com
184+
185+
[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
186+
[Next-url]: https://nextjs.org/
187+
188+
189+
190+

0 commit comments

Comments
 (0)