Merge pull request #92 from bhaskarblur/main

.gitignore

@@ -0,0 +1,3 @@
+bookTown-Nodejs/node_modules/
+bookTown-Nodejs/.env
+.DS_Store

bookTown-Nodejs/.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+.env

bookTown-Nodejs/DOCUMENTATION.md

@@ -0,0 +1,72 @@
+# BookTown Backend Application
+
+Hello everyone reading this, this is the backend app of BookTown Developed on Node js & Express js.
+The app uses Mongodb as it's primary database.
+
+## Guidelines to contribute
+
+This project welcomes contributors to contribute to the project & innovate new solutions to improve this project, 
+we appreciate your efforts in contributing to this project and we expect all the contributors to follow the guidelines
+to contribute to this project.
+
+1. Clean & Readable Code : We expect the contributors to write clean and efficient code that will not affect the current
+   codebase as well as keep the performance at best. Please keep in mind to keep write code that is easy to test & refract.
+   Please remove the unused objects from the code and use good naming conventions, also keep comments as less as possible.
+
+2. Follow a proper project structure: The project maintains the separation of concerns by keep the files in their own purpose.
+   We separate Controller, Routes, Database layer & other classes from each other for better codebase management & easy changes.
+   Please follow this project structure to contribute to this project effectively.
+
+3. Use environment variables(dotenv) for any sensitive configurations.
+
+
+## Setup Resources
+
+You would need to setup your own MongoDb Database in order to do operations with database as well as setup your environment variables
+via dotenv file or other environment mechanism.
+
+## API collection
+
+The API collection of this project can be found on Postman from the link below. Sample responses have been setup for each api
+so that contributors can test the API before impelementing them.
+
+Postman Link: (To be added)
+## How to Contribute
+
+1. Fork the repository to your GitHub account.
+2. Clone your forked repository to your local machine:
+
+```bash
+git clone https://github.com/YourUsername/BookTown.git
+```
+
+3. Create a new branch for your feature or bug fix:
+
+```bash
+git checkout -b feature/my-new-feature
+```
+
+4. Setup Node js Environment & Modules
+
+5. Run the app with:
+
+```bash
+npm run build
+```
+6. Push your changes to your fork on GitHub:
+
+```bash
+git push origin feature/my-new-feature
+```
+
+7. Open a pull request in this repository. Be sure to provide **a clear title and description** of your changes.
+
+8. Your pull request will be reviewed and merged once approved.
+
+## Getting Help
+
+If you need help or have questions, please [create an issue](https://github.com/Karamraj/BookTown/issues) in this repository.
+
+## Thank You
+
+Thank you for your contributions. Your help is greatly appreciated!

bookTown-Nodejs/nodemon.json

@@ -0,0 +1,6 @@
+{
+    "watch" : ["src"],
+    "ext": ".ts, .js",
+    "exec": "ts-node ./src/index.ts"
+
+}