PR for review

.env.example

@@ -0,0 +1,16 @@
+DB_HOST='localhost'
+DB_NAME='bookmyshow'
+DB_USER_NAME='panda'
+DB_PASSWORD=''
+
+JWT_SECRET='secret'
+
+
+REDIS_HOST=127.0.0.1
+REDIS_PORT=6379
+REDIS_DEFAULT_TIMEOUT_SECONDS=60
+
+ELASTIC_SEARCH_PORT=9200
+
+MONGODB_URI=mongodb+srv://iamashutoshpanda:hGEvTJ8tHUa3Hxgd@cluster0.cgcoqnr.mongodb.net/?retryWrites=true&w=majority
+NODE_ENV='UAT'

README.md

@@ -1,2 +1,35 @@
 # bookmyshow-api-nodejs-sql
-This repository contains the code for a movie ticket booking API. The API allows users to select a theatre in the city and see the dates of the next 7 days. Users can then click on any date to see all the movies in that theatre on that given date. Movies are displayed with details of all the showtimes.
+
+POSTMAN DOCS - [here](https://documenter.getpostman.com/view/7984450/2s93m5zgVx)
+
+#### This is an API for booking movie tickets.
+
+1. Get available movies for given - Cinema, Date
+2. Check available seats for a show
+3. Book tickets for a slot
+
+![er-diagram](./readme-assets/er-diagram.png)
+
+#### Which columns should be indexed?
+
+It's important to note that adding indexes also comes with some overhead, as they consume additional storage space and require maintenance during data modification operations (such as inserts, updates, and deletes).
+Hence we should add them only when a bottleneck is observed.
+
+In this example indexing the foreign keys for Shows table would be good as this will speed up our joins.
+Also if we want to prioritize them then indexing the HallId in Shows table should be prioritized as it is used more frequently than the rest.
+
+### Checklist
+
+- [x] JWT Auth
+- [x] Normalization of database
+- [x] Locking the DB while bulk operation with transactions
+- [x] Elastic Search for querying movies with filters(language, genre and dimension like 3D, 4D etc..) and fuzzy search
+- [x] Adding comments for a movie and retrieving with Mongo (for better write performance)
+- [x] Caching of movie details endpoints with Redis
+
+
+
+### Example Query for the UI below
+
+![example-query](./readme-assets/example-query.png)
+![bookmyshow-ui](./readme-assets/bookmyshow.jpeg)

index.js

@@ -0,0 +1,26 @@
+import dotenv from "dotenv";
+dotenv.config({ path: ".env.example" });
+import express from "express";
+import routes from "./src/routes/index.js";
+import connectDB from "./src/helpers/mongoose.js";
+// Make all variables from our .env file available in our process
+
+// Init express server
+const app = express();
+
+//rate limit
+await connectDB();
+app.use(express.json());
+app.use(express.urlencoded({ extended: true }));
+
+// Here we define the api routes
+app.use(routes);
+
+const port = process.env.PORT || 8080;
+const address = process.env.SERVER_ADDRESS || "localhost";
+
+app.get("/", (req, res) => res.send("Hello World!"));
+
+app.listen(port, () => console.log(`Server running on http://${address}:${port}`));
+
+export default app;