SETUP GUIDE
DEEP STEP BY STEP INSTRUCTIONS
MONGODB DATABASE SETUP
MONGODB IS WHERE ALL YOUR USER DATA AND PROJECT DETAILS ARE STORED PERMANENTLY. YOU HAVE TWO OPTIONS TO SET THIS UP A LOCAL INSTALLATION OR A CLOUD ATLAS ACCOUNT.
- OPTION A IS LOCAL INSTALLATION. YOU DOWNLOAD THE MONGODB COMMUNITY SERVER AND INSTALL IT ON YOUR COMPUTER.
- OPTION B IS CLOUD ATLAS. THIS IS THE RECOMMENDED WAY BECAUSE IT WORKS EVERYWHERE.
- GO TO HTTPS://WWW.MONGODB.COM/ATLAS AND CREATE A FREE ACCOUNT.
- CLICK ON CREATE A NEW CLUSTER AND CHOOSE THE FREE SHARED OPTION.
- GO TO THE NETWORK ACCESS TAB ON THE LEFT MENU AND CLICK ADD IP ADDRESS. CHOOSE ALLOW ACCESS FROM ANYWHERE. THIS SETS THE IP TO 0.0.0.0/0.
- GO TO THE DATABASE ACCESS TAB AND CLICK ADD NEW DATABASE USER. CREATE A USERNAME AND A STRONG PASSWORD AND WRITE IT DOWN SAFELY.
- GO BACK TO THE CLUSTERS TAB AND CLICK THE CONNECT BUTTON ON YOUR CLUSTER. CLICK CONNECT YOUR APPLICATION AND COPY THE LONG TEXT STRING.
IF YOU USE LOCAL INSTALLATION YOUR CONNECTION STRING WILL BE mongodb://localhost:27017/YourDBName. IF YOU USE ATLAS PASTE THE COPIED STRING INTO YOUR ENVIRONMENT FILE AND REPLACE THE WORD PASSWORD WITH THE ACTUAL PASSWORD YOU JUST CREATED.
MONGODB COMPASS SETUP
WHAT IS MONGODB COMPASS AND WHY USE IT
MONGODB COMPASS IS THE FREE OFFICIAL GRAPHICAL USER INTERFACE GUI FOR MONGODB. INSTEAD OF TYPING COMPLEX COMMANDS IN A BLACK TERMINAL COMPASS LETS YOU SEE SEARCH AND EDIT YOUR DATA VISUALLY LIKE A SPREADSHEET.
WHY YOU MUST USE COMPASS
VISUAL DATA EXPLORATION BROWSE ALL YOUR DATABASES COLLECTIONS AND DOCUMENTS IN A CLEAN READABLE FORMAT. NO MORE CONFUSING JSON WALLS.
BUILD QUERIES VISUALLY FILTER AND FIND DATA USING A POINT-AND-CLICK BUILDER. YOU CAN EVEN USE NATURAL LANGUAGE TO GENERATE QUERIES.
SCHEMA ANALYSIS COMPASS SAMPLES YOUR DATA AND SHOWS YOU THE STRUCTURE HELPING YOU SPOT MISSING FIELDS OR WRONG DATA TYPES.
POWERFUL AGGREGATIONS BUILD COMPLEX DATA PIPELINES STEP-BY-STEP WITH A VISUAL BUILDER AND SEE THE RESULTS IN REAL-TIME.
PERFORMANCE MONITORING ADD INDEXES CHECK QUERY SPEED AND UNDERSTAND WHY A QUERY IS SLOW WITH THE VISUAL EXPLAIN PLAN.
HOW TO DOWNLOAD AND INSTALL COMPASS ON WINDOWS
SYSTEM REQUIREMENTS YOU NEED A 64-BIT VERSION OF WINDOWS 10 OR WINDOWS SERVER 2019 OR NEWER AND MONGODB 7.0 OR HIGHER.
GO TO THE OFFICIAL DOWNLOAD PAGE HTTPS://WWW.MONGODB.COM/TRY/DOWNLOAD/COMPASS
SELECT YOUR OPERATING SYSTEM WINDOWS AND DOWNLOAD THE .EXE OR .MSI INSTALLER.
DOUBLE-CLICK THE DOWNLOADED INSTALLER FILE TO RUN IT.
FOLLOW THE INSTALLATION WIZARD. ACCEPT THE LICENSE AGREEMENT AND CHOOSE THE DEFAULT INSTALLATION LOCATION.
ONCE THE INSTALLATION IS COMPLETE LAUNCH MONGODB COMPASS FROM YOUR START MENU.
HOW TO CONNECT COMPASS TO YOUR DATABASE
COMPASS CAN CONNECT TO BOTH YOUR LOCAL MONGODB SERVER AND YOUR CLOUD ATLAS CLUSTER.
FOR LOCAL MONGODB OPEN COMPASS CLICK ON NEW CONNECTION AND IN THE URI FIELD ENTER mongodb://localhost:27017 THEN CLICK CONNECT.
FOR MONGODB ATLAS IN YOUR ATLAS DASHBOARD CLICK THE CONNECT BUTTON ON YOUR CLUSTER AND SELECT CONNECT WITH MONGODB COMPASS. COPY THE PROVIDED CONNECTION STRING.
PASTE THE ATLAS CONNECTION STRING INTO COMPASS URI FIELD. REPLACE THE WORD <PASSWORD> WITH YOUR ACTUAL DATABASE USER PASSWORD. CLICK CONNECT.
WHAT TO CHECK INSIDE COMPASS
DATABASES AND COLLECTIONS AFTER CONNECTING YOU WILL SEE A LIST OF ALL YOUR DATABASES ON THE LEFT SIDEBAR. EXPAND A DATABASE TO SEE ITS COLLECTIONS LIKE TABLES IN SQL.
DOCUMENTS CLICK ON A COLLECTION TO VIEW ALL ITS DOCUMENTS IN A READABLE TABLE OR JSON VIEW.
SCHEMA TAB ANALYZE THE STRUCTURE OF YOUR DATA TO ENSURE FIELDS ARE CONSISTENT.
INDEXES TAB CHECK WHICH FIELDS ARE INDEXED FOR FASTER QUERIES.
AGGREGATIONS TAB USE THE VISUAL BUILDER TO CREATE DATA PIPELINES STEP-BY-STEP.
REDIS CACHING SETUP
ALUMIQ USES REDIS AS A FAST IN MEMORY DATA STORE FOR CACHING AND TRACKING UNIQUE JOB VIEWS. WHILE REDIS IS TRADITIONALLY A LINUX TOOL YOU CAN RUN IT EASILY ON WINDOWS FOR DEVELOPMENT.
- GO TO HTTPS://WWW.MEMURAI.COM/GET-MEMURAI/ AND DOWNLOAD THE FREE DEVELOPER EDITION.
- MEMURAI IS THE OFFICIAL REDIS PARTNER FOR WINDOWS AND PROVIDES A SIMPLE INSTALLER.
- RUN THE INSTALLER BY DOUBLE CLICKING THE MSI FILE.
- JUST CLICK NEXT THROUGH THE SETUP WIZARD AND ACCEPT THE LICENSE AGREEMENT. CHOOSE THE DEFAULT INSTALLATION PATH.
ONCE THE INSTALLATION IS COMPLETE REDIS IS ALREADY RUNNING ON THE DEFAULT PORT 6379. ADD THE LINE REDIS_URL=redis://localhost:6379 TO YOUR ALUMIQ BACKEND ENV FILE. YOU CAN VERIFY IT IS RUNNING BY LOOKING FOR THE MEMURAI SERVICE IN YOUR WINDOWS SERVICES LIST.
JWT SECURITY TOKENS
JWT STANDS FOR JSON WEB TOKEN. IT ACTS LIKE A DIGITAL VIP PASS FOR YOUR USERS. WHEN A USER LOGS IN THE SERVER GIVES THEM THIS PASS SO THEY DO NOT HAVE TO LOG IN AGAIN AND AGAIN.
- THE JWT SECRET IS A TOP SECRET PASSWORD USED TO LOCK THIS VIP PASS. IF SOMEONE ELSE GETS THIS PASSWORD THEY CAN CREATE FAKE PASSES AND HACK YOUR WEBSITE.
- YOU DO NOT BUY THIS KEY. YOU MAKE IT YOURSELF BY GOING TO HTTPS://RANDOMKEYGEN.COM/ AND COPYING A VERY LONG STRING.
- THE JWT EXPIRE VALUE TELLS THE SYSTEM HOW LONG THE VIP PASS IS VALID. A VALUE OF 7D MEANS THE PASS IS VALID FOR 7 DAYS.
- THE JWT REFRESH SECRET IS ANOTHER PASSWORD USED TO ISSUE A NEW PASS WITHOUT ASKING THE USER TO LOG IN AGAIN.
- THE JWT REFRESH EXPIRE VALUE TELLS THE SYSTEM HOW LONG THIS REFRESH PASS LASTS. A VALUE OF 30D MEANS 30 DAYS.
COPY THESE LONG STRINGS AND PASTE THEM INTO YOUR ENVIRONMENT FILE. NEVER SHARE THESE SECRETS WITH ANYONE.
CLOUDINARY IMAGE STORAGE
CLOUDINARY IS THE ONLINE STORAGE SERVICE WHERE ALL USER PROFILE PICTURES AND PROJECT IMAGES ARE SAVED. IT KEEPS YOUR MAIN SERVER FAST BECAUSE IT HANDLES ALL THE HEAVY IMAGE LOADING.
- GO TO HTTPS://CLOUDINARY.COM/ AND SIGN UP FOR A FREE ACCOUNT.
- AFTER SIGNING UP YOU WILL LAND ON THE DASHBOARD PAGE.
- ON THE DASHBOARD PAGE YOU WILL SEE THREE IMPORTANT PIECES OF INFORMATION.
- THE FIRST IS YOUR CLOUD NAME. THE SECOND IS YOUR API KEY. THE THIRD IS YOUR API SECRET.
COPY ALL THREE VALUES AND PASTE THEM INTO YOUR ENVIRONMENT FILE EXACTLY AS THEY ARE SHOWN. THESE ARE REQUIRED TO SECURELY UPLOAD IMAGES.
AI AND EMAIL SETUP
GROQ AI FEATURES
- GROQ IS THE ARTIFICIAL INTELLIGENCE SERVICE THAT POWERS ALL THE SMART FEATURES ON YOUR WEBSITE.
- GO TO HTTPS://CONSOLE.GROQ.COM/ AND CREATE A FREE ACCOUNT.
- ON THE LEFT SIDE MENU CLICK ON API KEYS.
- CLICK THE CREATE API KEY BUTTON AND GIVE IT ANY NAME YOU LIKE.
COPY THE KEY THAT IS GENERATED. IT STARTS WITH THE LETTERS G S K. PASTE THIS KEY AS YOUR GROQ API KEY IN THE ENV FILE.
CRITICAL EMAIL SETUP
NORMAL GMAIL PASSWORDS WILL NOT WORK HERE. YOU MUST GENERATE A SPECIAL APP PASSWORD.
- OPEN YOUR GOOGLE ACCOUNT SETTINGS AND GO TO THE SECURITY TAB.
- TURN ON 2 STEP VERIFICATION. YOU CANNOT CREATE AN APP PASSWORD WITHOUT THIS.
- IN THE SEARCH BAR AT THE TOP TYPE APP PASSWORDS AND CLICK THE RESULT.
- CREATE A NEW APP PASSWORD AND GIVE IT A NAME LIKE MERN PROJECT.
GOOGLE WILL SHOW YOU A 16 LETTER PASSWORD. COPY THIS PASSWORD AND PASTE IT AS YOUR EMAIL PASS.
RAZORPAY PAYMENT GATEWAY
RAZORPAY IS THE SERVICE THAT ALLOWS YOUR WEBSITE TO ACCEPT MONEY FROM CUSTOMERS. IT HANDLES CREDIT CARDS UPI AND NET BANKING SECURELY. YOU DO NOT NEED TO PAY ANY MONEY TO GET STARTED.
- GO TO HTTPS://DASHBOARD.RAZORPAY.COM/ AND LOG IN TO YOUR FREE ACCOUNT.
- ON THE LEFT SIDE MENU GO TO SETTINGS AND CLICK ON API KEYS.
- CLICK THE GENERATE TEST KEY BUTTON.
- YOU WILL BE SHOWN TWO THINGS. A TEST KEY ID AND A TEST KEY SECRET.
TEST KEYS ARE COMPLETELY FREE AND DO NOT INVOLVE REAL MONEY. USE THESE TEST KEYS FOR LOCAL DEVELOPMENT. WHEN YOUR WEBSITE IS READY TO GO LIVE YOU WILL COMPLETE YOUR KYC AND GENERATE LIVE KEYS. THE KEY ID IS PUBLIC BUT THE KEY SECRET IS PRIVATE AND MUST NEVER BE SHARED.
WAQI AIR QUALITY TOKEN
AIRSENSE USES THE WORLD AIR QUALITY INDEX API TO FETCH REAL TIME AIR QUALITY DATA. A FREE TOKEN IS REQUIRED TO USE THIS SERVICE.
- GO TO HTTPS://AQICN.ORG/DATA-PLATFORM/TOKEN/.
- READ AND AGREE TO THE TERMS OF SERVICE.
- ENTER YOUR EMAIL ADDRESS AND YOUR NAME.
- CLICK SUBMIT AND YOUR TOKEN WILL BE GENERATED INSTANTLY.
COPY THIS TOKEN AND PASTE IT AS YOUR WAQI TOKEN IN THE ENV FILE. THE DEMO TOKEN WORKS FOR LIMITED TESTING BUT MAY STOP WORKING. YOU MUST REGISTER FOR A FREE TOKEN FOR PRODUCTION USE.
STOCKFISH CHESS ENGINE
CHESSFORGE USES THE STOCKFISH ENGINE TO ANALYZE CHESS POSITIONS. THIS IS A POWERFUL OPEN SOURCE CHESS ENGINE.
- GO TO HTTPS://STOCKFISHCHESS.ORG/DOWNLOAD/.
- FOR WINDOWS 64 BIT DOWNLOAD THE FILE NAMED STOCKFISH WINDOWS X64 DOT ZIP.
- FOR MODERN CPUS WITH AVX2 SUPPORT DOWNLOAD THE FILE NAMED STOCKFISH WINDOWS X64 AVX2 DOT ZIP.
- UNZIP THE DOWNLOADED FILE. YOU WILL GET A FILE NAMED STOCKFISH DOT EXE.
- COPY THIS FILE AND PASTE IT DIRECTLY INSIDE YOUR BACKEND FOLDER.
THE FINAL PATH SHOULD BE BACKEND SLASH STOCKFISH DOT EXE. RESTART YOUR BACKEND SERVER USING THE COMMAND NPM RUN DEV. VERIFY THAT THE CONSOLE SHOWS A MESSAGE SAYING STOCKFISH IS READY.