Skip to content

Commit 48e38ea

Browse files
updated readme
1 parent dd249a6 commit 48e38ea

File tree

1 file changed

+103
-9
lines changed

1 file changed

+103
-9
lines changed

1Application-frontend/README.md

Lines changed: 103 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,112 @@
1-
# React + Vite
1+
<h1 align="center" id="title">Javascript Project Showcase</h1>
22

3-
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
3+
<p align="center"><img src="https://vitejs.dev/ecosystem-vite4.png" alt="project-image"></p>
44

5-
Currently, two official plugins are available:
5+
<p id="description">Welcome to the MERN JavaScript Project Showcase a single comprehensive website dedicated to presenting a diverse and dynamic collection of projects powered by the MERN (MongoDB Express React Node.js) stack. This platform is designed to be a one-stop destination for developers learners and tech enthusiasts to explore a wide array of web applications tools and solutions all developed using the MERN stack.</p>
66

7-
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
8-
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
7+
8+
9+
<h2>🧐 Features</h2>
910

10-
## To start the project
11+
Here're some of the project's best features:
1112

12-
- [1] cd 1Application-frontend
13+
* Diverse Project Portfolio: Explore a rich array of projects including web applications APIs and full-stack solutions each demonstrating the capabilities of the MERN stack.
14+
* In-Depth Documentation: Every project is accompanied by detailed documentation offering insights into its features architecture and usage.
15+
* Search and Filter: Easily find projects by name category technology stack or specific features making it simple to discover projects aligned with your interests.
16+
* ontributions: Contribute your own MERN stack projects to the showcase allowing others to learn from and be inspired by your work.
17+
* Community Interaction: Engage with the MERN development community by discussing projects sharing feedback asking questions and fostering collaboration.
18+
19+
<h2>🛠️ Installation Steps:</h2>
20+
21+
<p>1. Fork the repo</p>
22+
23+
```
24+
Fork
25+
```
26+
27+
<p>2. clone the repo</p>
28+
29+
```
30+
git clone url
31+
```
32+
33+
<p>3. sync always</p>
34+
35+
```
36+
git sync
37+
```
38+
39+
<p>4. Go to main folder</p>
40+
41+
```
42+
cd 1Application-frontend
43+
```
44+
45+
<p>5. Install dependencencies</p>
46+
47+
```
48+
npm install
49+
```
50+
51+
<p>6. start the server</p>
52+
53+
```
54+
npm run dev
55+
```
56+
57+
<h2>🍰 Contribution Guidelines:</h2>
58+
59+
We appreciate your interest in contributing to the JavaScript Project Showcase. To ensure a smooth and collaborative experience for everyone please follow these guidelines:
60+
61+
* * *
62+
63+
* Before You Start :
64+
Fork the Repository: To get started fork the repository to your GitHub account.
65+
Clone the Repository:
66+
After forking clone the repository to your local machine using git clone.
67+
Stay Updated:
68+
Regularly sync your forked repository with the main repository using git sync. This keeps your fork up-to-date with the latest changes.
69+
70+
* * *
71+
72+
* Contributing a Project
73+
**Create a New Branch: Always create a new branch for your contribution. Use a descriptive name for the branch like feature/new-project or fix/bug-fix.
74+
**Project Documentation: Ensure that your project comes with detailed documentation. This should include instructions on how to set up and run the project locally.
75+
**Code Quality: Maintain good code quality by adhering to best practices and coding standards. Ensure your code is clean and well-documented.
76+
**Testing: If applicable provide unit tests for your code to maintain its stability.
77+
**Respect Licensing: Ensure that your project complies with open-source licenses. Only contribute projects for which you have the rights and permissions.
78+
**No Spamming: Do not add spammy offensive or irrelevant content to the showcase. Contributions should be meaningful and useful to the community.
79+
************
80+
* ******Submitting a Pull Request
81+
**Open a Pull Request: When you are ready to submit your contribution open a pull request to the main repository.
82+
**Clear Description: Provide a clear and concise description of your project or contribution. Include the purpose features and any additional information that would be helpful.
83+
**Review and Feedback: Be open to feedback and discussions during the review process. Your contribution may be refined based on community input.
84+
**License Agreement: By contributing you agree that your work will be licensed under the project's open-source license.
85+
**No Plagiarism: Do not submit projects that are not your own and always give credit to sources when necessary.
86+
**Maintain Respect: Be respectful and professional when communicating with other contributors and maintain a positive and inclusive atmosphere.
87+
******************
88+
* ******Community Interaction
89+
Engage Responsibly: Participate in discussions and collaborate with other community members respectfully and constructively.
90+
No Harassment or Spam: Do not engage in harassment spam or any form of disruptive behavior. Report any such behavior to the maintainers.**
91+
Share Your Feedback: Share your feedback questions and suggestions with others to help improve the showcase.**
92+
93+
94+
95+
<h2>💻 Built with</h2>
96+
97+
Technologies used in the project:
98+
99+
* HTML
100+
* CSS
101+
* Javascript
102+
* React
103+
* Express
104+
* Rest Api's
105+
106+
107+
108+
**********
13109

14-
- [2] npm install
15110

16-
- [3] npm run dev
17111

18112

0 commit comments

Comments
 (0)