Skip to content

Commit c6dfdb6

Browse files
updated readme
1 parent 24c2576 commit c6dfdb6

File tree

1 file changed

+74
-17
lines changed

1 file changed

+74
-17
lines changed

Diff for: README.md

+74-17
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,74 @@
1-
In this project we will build a realtime online pizza order app using Node Js, Express Js and Mongo DB. we will be using tailwind css for frontend as a css framework and will be using EJS template engine as well. we will be using socket.io for realtime communication.
2-
3-
Using This app we will be able to order a pizza and get realtime notifications about pizza status.
4-
5-
In this Project we will cover following topics:
6-
1. Login system
7-
- Cookies and sessions
8-
- Use Database as session store
9-
2. Registration
10-
3. User roles
11-
4. Shopping cart
12-
5. Realtime pizza status tracker
13-
- Real time web socket private connections
14-
6. Git
15-
7. ES6 and SCSS
16-
8. Express project unique architecture
17-
and many other things.
1+
# Tasty Traffic Pizza: Realtime pizza app using Node-express-mongo-socket.io
2+
3+
A *realtime pizza order web-app* using Node Js, Express Js and Mongo DB. I have used EJS template engine and Tailwind CSS for frontend as a css framework. I have also used socket.io for updating the status of orders in realtime.
4+
5+
***If you have some more ideas for the project then feel free to open an issue for that***
6+
7+
#### Check the `routes folder` for all the routes.
8+
9+
<br>
10+
11+
## Code of Conduct
12+
We would request you to cooperate with our maintainers and comply with the revisions they request and maintain the code of conduct while working on this project.
13+
14+
`Make sure you are assigned to the issue before working on it.`
15+
16+
<br>
17+
18+
## Steps to setup this project locally
19+
20+
![Steps](https://media.giphy.com/media/o5BzNDDFQnepi/giphy.gif)
21+
22+
1. `Fork` this repository.
23+
24+
2. Fire up your `terminal or Git Bash.`
25+
26+
3. Navigate to the folder/directory where you want to download the project.
27+
28+
```terminal
29+
cd DIRECTORY_PATH
30+
```
31+
4. Clone the forked repository to your local system.
32+
33+
```terminal
34+
git clone https://github.com/<your-github-username>/
35+
Tasty-Traffic-Pizza
36+
```
37+
38+
5. Navigate to the project directory.
39+
40+
```terminal
41+
cd Tasty-Traffic-Pizza
42+
```
43+
44+
6. Create a new branch.
45+
46+
```terminal
47+
git checkout -b <your-branch-name>
48+
```
49+
50+
7. Make changes in source code.
51+
52+
![changes](https://media.giphy.com/media/QNFhOolVeCzPQ2Mx85/200w_d.gif)
53+
54+
8. Commit your changes.
55+
```terminal
56+
git commit -am 'your commit message'
57+
```
58+
59+
9. Push your local branch to the remote repository.
60+
```terminal
61+
git push origin <your-branch-name>
62+
```
63+
64+
10. Create a Pull Request!
65+
66+
* Finally, go to your repository in browser and click on `compare and pull request`.
67+
Then add a title and description to your pull request that explains your precious effort.
68+
69+
* click on `Compare and Pull Request`
70+
71+
**Congratulations!** :boom: Sit and relax, you've made your contribution to the project.
72+
73+
74+
# Happy Coding 😄😄

0 commit comments

Comments
 (0)