From acfe79a4d02517a86c082e321baf0cb4e3c42344 Mon Sep 17 00:00:00 2001
From: Suppandi <121857153+Suppandi-1@users.noreply.github.com>
Date: Thu, 7 Dec 2023 17:03:08 +0530
Subject: [PATCH 1/2] added contribution.md and improved readme.md
---
CONTRIBUTION.md | 11 ++++++++
readme.md | 72 ++++++++++++++++++++++---------------------------
2 files changed, 43 insertions(+), 40 deletions(-)
create mode 100644 CONTRIBUTION.md
diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md
new file mode 100644
index 0000000..333ee8e
--- /dev/null
+++ b/CONTRIBUTION.md
@@ -0,0 +1,11 @@
+## Contribution Guidelines
+
+We welcome contributions to the CodeChef CU Chapter Backend. To contribute, follow these guidelines:
+
+1. Fork the repository.
+2. Create a new branch for your feature or bug fix: `git checkout -b feature-name`.
+3. Make your changes and commit them with a clear and concise message.
+4. Push your changes to your fork: `git push origin feature-name`.
+5. Open a pull request, referencing any relevant issues.
+
+Ensure your code adheres to the existing coding standards and includes relevant tests.
diff --git a/readme.md b/readme.md
index 64425d2..532d7ba 100644
--- a/readme.md
+++ b/readme.md
@@ -1,53 +1,45 @@
-# CodeChef CU Chapter Backend
+CodeChef CU Chapter Backend
-Welcome to the backend repository of CodeChef CU Chapter! This Node.js backend is designed to work in conjunction with the frontend to provide a complete web application experience.
+ Welcome to the backend repository of CodeChef CU Chapter! This Node.js backend is an integral part of our web application, working seamlessly with the frontend to provide a complete user experience.
-
+ 
-## Table of Contents
+ Table of Contents
-- [About CodeChef CU Chapter Backend](#about-codechef-cu-chapter-backend)
-- [Technologies](#technologies)
-- [Getting Started](#getting-started)
-- [API Endpoints](https://api.cuchapter.tech/)
-- [Contribution Guidelines](#contribution-guidelines)
-- [License](#license)
+
-## About CodeChef CU Chapter Backend
+ About CodeChef CU Chapter Backend
-CodeChef CU Chapter Backend is the server-side component of the CodeChef CU Chapter web application. It handles data storage, retrieval, and business logic required for the functioning of the application.
+ CodeChef CU Chapter Backend serves as the backbone for the CodeChef CU Chapter web application. It manages data storage, retrieval, and the essential business logic needed for the application's smooth operation.
-## Technologies
+ Technologies
-- **Node.js**: Server-side JavaScript runtime.
-- **Express.js**: Web application framework for Node.js.
-- **MongoDB**: NoSQL database for data storage.
-- **Mongoose**: MongoDB object modeling for Node.js.
-- **Other dependencies**: List any additional dependencies or tools used.
+
+ - Node.js: A versatile server-side JavaScript runtime.
+ - Express.js: A powerful web application framework for Node.js.
+ - MongoDB: A robust NoSQL database for efficient data storage.
+ - Mongoose: A MongoDB object modeling tool for Node.js.
+ - Other dependencies: Include any additional dependencies or tools relevant to your backend.
+
-## Getting Started
+ Getting Started
-To get the backend up and running locally, follow these steps:
+
+ - Clone the repository:
git clone https://github.com/cu-coders/backend.git
+ - Install dependencies:
npm install
+ - Set up environment variables
+ - Start the server:
npm start
+
-1. Clone the repository: `git clone https://github.com/cu-coders/backend.git`
-2. Install dependencies: `npm install`
-3. Set up environment variables
-4. Start the server: `npm start`
+ License
-## Contribution Guidelines
+ This project is licensed under the MIT License. You are encouraged to customize this template based on your backend's specifics and include any additional details that would be helpful for contributors.
-We welcome contributions to the CodeChef CU Chapter Backend. To contribute, follow these guidelines:
-
-1. Fork the repository.
-2. Create a new branch for your feature or bug fix: `git checkout -b feature-name`.
-3. Make your changes and commit them with a clear and concise message.
-4. Push your changes to your fork: `git push origin feature-name`.
-5. Open a pull request, referencing any relevant issues.
-
-Ensure your code adheres to the existing coding standards and includes relevant tests.
-
-## License
-
-This project is licensed under the [MIT License](LICENSE).
-
-Feel free to customize this template based on the specific details of your backend, and include any additional information that might be relevant for contributors.
+ Feel free to reach out if you have any questions or need further assistance. Happy coding!
From e2ac4dde3690abf4e74f049e76396eb46bd2a4e6 Mon Sep 17 00:00:00 2001
From: Suppandi <121857153+Suppandi-1@users.noreply.github.com>
Date: Thu, 7 Dec 2023 17:05:05 +0530
Subject: [PATCH 2/2] readme.md
---
readme.md | 60 ++++++++++++++++++++++++++-----------------------------
1 file changed, 28 insertions(+), 32 deletions(-)
diff --git a/readme.md b/readme.md
index 532d7ba..40e96aa 100644
--- a/readme.md
+++ b/readme.md
@@ -1,45 +1,41 @@
-CodeChef CU Chapter Backend
+# CodeChef CU Chapter Backend
- Welcome to the backend repository of CodeChef CU Chapter! This Node.js backend is an integral part of our web application, working seamlessly with the frontend to provide a complete user experience.
+Welcome to the backend repository of CodeChef CU Chapter! This Node.js backend is designed to work in conjunction with the frontend to provide a complete web application experience.
-
+
- Table of Contents
+## Table of Contents
-
+- [About CodeChef CU Chapter Backend](#about-codechef-cu-chapter-backend)
+- [Technologies](#technologies)
+- [Getting Started](#getting-started)
+- [API Endpoints](https://api.cuchapter.tech/)
+- [Contribution Guidelines](#contribution-guidelines)
+- [License](#license)
- About CodeChef CU Chapter Backend
+## About CodeChef CU Chapter Backend
- CodeChef CU Chapter Backend serves as the backbone for the CodeChef CU Chapter web application. It manages data storage, retrieval, and the essential business logic needed for the application's smooth operation.
+CodeChef CU Chapter Backend is the server-side component of the CodeChef CU Chapter web application. It handles data storage, retrieval, and business logic required for the functioning of the application.
- Technologies
+## Technologies
-
- - Node.js: A versatile server-side JavaScript runtime.
- - Express.js: A powerful web application framework for Node.js.
- - MongoDB: A robust NoSQL database for efficient data storage.
- - Mongoose: A MongoDB object modeling tool for Node.js.
- - Other dependencies: Include any additional dependencies or tools relevant to your backend.
-
+- **Node.js**: Server-side JavaScript runtime.
+- **Express.js**: Web application framework for Node.js.
+- **MongoDB**: NoSQL database for data storage.
+- **Mongoose**: MongoDB object modeling for Node.js.
+- **Other dependencies**: List any additional dependencies or tools used.
- Getting Started
+## Getting Started
-
- - Clone the repository:
git clone https://github.com/cu-coders/backend.git
- - Install dependencies:
npm install
- - Set up environment variables
- - Start the server:
npm start
-
+To get the backend up and running locally, follow these steps:
- License
+1. Clone the repository: `git clone https://github.com/cu-coders/backend.git`
+2. Install dependencies: `npm install`
+3. Set up environment variables
+4. Start the server: `npm start`
- This project is licensed under the MIT License. You are encouraged to customize this template based on your backend's specifics and include any additional details that would be helpful for contributors.
+## License
- Feel free to reach out if you have any questions or need further assistance. Happy coding!
+This project is licensed under the [MIT License](LICENSE).
+
+Feel free to customize this template based on the specific details of your backend, and include any additional information that might be relevant for contributors.