Skip to content

Commit e9054a9

Browse files
author
vignesh
committed
Update README.md file
1 parent 56d87c8 commit e9054a9

File tree

1 file changed

+212
-2
lines changed

1 file changed

+212
-2
lines changed

‎README.md

+212-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Real Time Chat with Django
1+
<!-- # Real Time Chat with Django
22
Real Time Chat App is made using Django to communicate with members in Real Time.
33
44
## Prerequisits
@@ -37,4 +37,214 @@ to discuss what you would like to change.
3737
3838
## License
3939
40-
[MIT](https://github.com/VigneshVicky97/Real-Time-Chat-with-Django/blob/main/LICENSE)
40+
[MIT](https://github.com/VigneshVicky97/Real-Time-Chat-with-Django/blob/main/LICENSE) -->
41+
42+
43+
44+
45+
46+
47+
<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
48+
<a name="readme-top"></a>
49+
<!--
50+
*** Thanks for checking out the Best-README-Template. If you have a suggestion
51+
*** that would make this better, please fork the repo and create a pull request
52+
*** or simply open an issue with the tag "enhancement".
53+
*** Don't forget to give the project a star!
54+
*** Thanks again! Now go create something AMAZING! :D
55+
-->
56+
57+
58+
59+
<!-- PROJECT SHIELDS -->
60+
<!--
61+
*** I'm using markdown "reference style" links for readability.
62+
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
63+
*** See the bottom of this document for the declaration of the reference variables
64+
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
65+
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
66+
-->
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+
74+
75+
76+
<!-- PROJECT LOGO -->
77+
<br />
78+
<div align="center">
79+
<a href="https://github.com/github_username/repo_name">
80+
<img src="images/logo.png" alt="Logo" width="80" height="80">
81+
</a>
82+
83+
<h3 align="center">Real Time Chat with Django</h3>
84+
85+
<p align="center">
86+
Real Time Chat App is made using Django to communicate with members in Real Time.
87+
<br />
88+
<a href="https://github.com/github_username/repo_name"><strong>Explore the docs »</strong></a>
89+
<br />
90+
<br />
91+
<a href="https://github.com/github_username/repo_name">View Demo</a>
92+
·
93+
<a href="https://github.com/github_username/repo_name/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
94+
·
95+
<a href="https://github.com/github_username/repo_name/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>
96+
</p>
97+
</div>
98+
99+
100+
101+
<!-- TABLE OF CONTENTS -->
102+
<details>
103+
<summary>Table of Contents</summary>
104+
<ol>
105+
<li>
106+
<a href="#about-the-project">About The Project</a>
107+
<ul>
108+
<li><a href="#built-with">Built With</a></li>
109+
</ul>
110+
</li>
111+
<li>
112+
<a href="#getting-started">Getting Started</a>
113+
<ul>
114+
<li><a href="#prerequisites">Prerequisites</a></li>
115+
<li><a href="#installation">Installation</a></li>
116+
</ul>
117+
</li>
118+
<li><a href="#usage">Usage</a></li>
119+
<li><a href="#roadmap">Roadmap</a></li>
120+
<li><a href="#contributing">Contributing</a></li>
121+
<li><a href="#license">License</a></li>
122+
<li><a href="#contact">Contact</a></li>
123+
<li><a href="#acknowledgments">Acknowledgments</a></li>
124+
</ol>
125+
</details>
126+
127+
128+
129+
<!-- ABOUT THE PROJECT -->
130+
## About The Project
131+
132+
[![Product Name Screen Shot][product-screenshot]](https://example.com)
133+
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`
135+
136+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
137+
138+
139+
140+
### Built With
141+
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]
150+
151+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
152+
153+
154+
155+
<!-- GETTING STARTED -->
156+
## Getting Started
157+
158+
This is an example of how you may give instructions on setting up your project locally.
159+
To get a local copy up and running follow these simple example steps.
160+
161+
### Prerequisites
162+
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+
```
168+
169+
### Installation
170+
171+
1. Get a free API Key at [https://example.com](https://example.com)
172+
2. Clone the repo
173+
```sh
174+
git clone https://github.com/VigneshVicky97/Real-Time-Chat-with-Django.git
175+
```
176+
3. Navigate to the project directory
177+
```sh
178+
cd Real-Time-Chat-with-Django
179+
```
180+
4. Install the dependencies
181+
```sh
182+
pip install -r requirements.txt
183+
```
184+
5. Run the project
185+
```sh
186+
cd DjangoChat
187+
python manage.py runserver
188+
```
189+
190+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
191+
192+
193+
194+
<!-- CONTRIBUTING -->
195+
## Contributing
196+
197+
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
198+
199+
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
200+
Don't forget to give the project a star! Thanks again!
201+
202+
1. Fork the Project
203+
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
204+
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
205+
4. Push to the Branch (`git push origin feature/AmazingFeature`)
206+
5. Open a Pull Request
207+
208+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
209+
210+
211+
212+
<!-- LICENSE -->
213+
## License
214+
215+
Distributed under the MIT License. See `LICENSE.txt` for more information.
216+
217+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
218+
219+
220+
<!-- MARKDOWN LINKS & IMAGES -->
221+
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
222+
[contributors-shield]: https://img.shields.io/github/contributors/github_username/repo_name.svg?style=for-the-badge
223+
[contributors-url]: https://github.com/github_username/repo_name/graphs/contributors
224+
[forks-shield]: https://img.shields.io/github/forks/github_username/repo_name.svg?style=for-the-badge
225+
[forks-url]: https://github.com/github_username/repo_name/network/members
226+
[stars-shield]: https://img.shields.io/github/stars/github_username/repo_name.svg?style=for-the-badge
227+
[stars-url]: https://github.com/github_username/repo_name/stargazers
228+
[issues-shield]: https://img.shields.io/github/issues/github_username/repo_name.svg?style=for-the-badge
229+
[issues-url]: https://github.com/github_username/repo_name/issues
230+
[license-shield]: https://img.shields.io/github/license/github_username/repo_name.svg?style=for-the-badge
231+
[license-url]: https://github.com/github_username/repo_name/blob/master/LICENSE.txt
232+
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
233+
[linkedin-url]: https://linkedin.com/in/linkedin_username
234+
[product-screenshot]: images/screenshot.png
235+
[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
236+
[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

0 commit comments

Comments
 (0)