Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Summary about the project #6

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Added Summary about the project #6

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e80b7c5
Added Summary about the project
Shivam7-1 Dec 6, 2020
9749fa5
Merge branch 'master' into patch-1
Shivam7-1 Dec 30, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,29 @@
<img src="./Untitled design.png">

<p>

##About Project:
It is an e-commerce web app with an utterly responsive UI, proper user authentication using bcrypt, admin and user panel, CRUD operations in backend for managing products, categories, and users, Razorpay payment gateway, and dark mode. It was built using MERN stack and hosted using Heroku for backend, MongoDB Atlas for database, and Netlify for frontend
<h2>Contribution Guidelines:</h2>
<ul>
<li>Fork the repository.</li>
<li>Clone the repository (git clone URL).</li>
<li>Open the folder in which you cloned the repository.</li>
<li>Run npm install.</li>
<li>Create a .env file same as the given env file (.example.env).</li>
<li>Setup your backend using this repository <a href="https://github.com/kunaljain0212/Apni-Dukaan-Backend">BACKEND</a>. Now you can either deploy your backend separately and use the hosted link or run localy and use that respective link.</li>
<li>After you successfully add the backend url to your .env file you can run npm start start working localy.</li>
<li>Now you can make changes and see them localy.</li>
<li>After making the changes run git checkout -b BRANCH_NAME to create a new branch.</li>
<li>Run git add . to stage the changes.</li>
<li>Run git commit -m MESSAGE to commit the changes.</li>
<li>Run git push origin BRANCH_NAME to push the changes.</li>
<li>Now make a Pull Request and wait for it to get merged.</li>
</ul>
</p>

<h2><a href="https://github.com/kunaljain0212/Apni-Dukan-Frontent/blob/master/CONTRIBUTION.md">Contribution Guidelines</a></h2>


<h5><a href="https://github.com/kunaljain0212/Apni-Dukan-Frontent/blob/master/LICENSE">LICENSE</a></h5>

<h5><a href="https://github.com/kunaljain0212/Apni-Dukan-Frontent/blob/master/LICENSE">LICENSE</a></h5>